Skip to main content

Quickstart Guide

This guide takes you from your API key to a full payout in a few minutes.

Prerequisites​

info

You will need an API key to proceed. If you don't have one, please contact support@abroad.com.

  • Base URL: https://api.abroad.finance
  • HTTP client: curl, Postman, or similar.

1) Create a quote (target payout)​

Ask for how much crypto you need to send to deliver a specific local amount. In this example the recipient should get 400,000 COP via BreB.

curl -X POST https://api.abroad.finance/quote \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 400000,
    "crypto_currency": "USDC",
    "network": "STELLAR",
    "payment_method": "BREB",
    "target_currency": "COP"
  }'
tip

value is the crypto amount (USDC) you need to send before the expiration_time (epoch ms). Copy the quote_id for the next step.

2) Accept the transaction​

Register the recipient and lock the quote. Include your internal user_id so you can reconcile webhooks later.

curl -X POST https://api.abroad.finance/transaction \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "quote_id": "550e8400-e29b-41d4-a716-446655440000",
    "user_id": "test-user-01",
    "account_number": "3001234567",
    "bank_code": "9101"
  }'
KYC Requirement

If kycLink is not null, you must redirect the user to that URL to complete identity verification before the transaction can proceed.

Bank code note: bank_code is optional for supported methods. Include it only if a specific rail or bank identifier is required for the payout.

3) Send funds on-chain​

Send the value amount of crypto to the Abroad deposit address for the chosen network.

Critical

You must include the transaction_reference exactly as the memo/note in your crypto transfer. Failure to do so will result in lost funds.

See Send Funds for detailed instructions.

4) Track status​

Poll or subscribe to webhooks until the payout completes:

curl -X GET https://api.abroad.finance/transaction/f4a96c4c-4d1e-4ab2-a6ec-2e1b5070c5db \
  -H "X-API-Key: YOUR_API_KEY"

Status values and webhook events are listed in Status lifecycle.

Next steps​