Skip to main content

Integration Basics

The essentials you need before wiring Abroad into your stack.

Base URL

EnvironmentBase URL
Productionhttps://api.abroad.finance

All endpoints live directly under the base URL (for example: POST /quote).

Authentication & headers

  • Partner auth: include X-API-Key: <your key> on every call.
  • Wallet/user auth (where required): Authorization: Bearer <token>.
  • Always send JSON payloads: Content-Type: application/json.
  • Endpoints may accept either scheme; sending both is safe.

See Authentication for concrete examples.

IDs, time, and memos

  • quote_id is a UUID.
  • transaction_reference is the Base64 form of the transaction ID; use it verbatim as the memo/notes field when sending crypto.
  • expiration_time is an epoch timestamp in milliseconds. Quotes are valid until that time (currently up to 1 hour).

Supported values (request enums)

FieldAllowed values
crypto_currencyUSDC
networkSTELLAR, SOLANA
payment_methodBREB, PIX
target_currencyCOP, BRL

Check Supported Assets for the full matrix and payment method availability.

Operational tips

  • Quotes expire; if funds arrive after the expiration_time, you will see PAYMENT_EXPIRED when checking the transaction.
  • Start with small amounts while validating KYC flows, bank details, and error handling.
  • Configure your webhook receiver and verify the X-Abroad-Webhook-Secret header before relying on callbacks.