Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Transfer funds between your own accounts in different currencies.

post/v1/global-payout/exchange/authorize

Headers

Authorizationstring required
Example:Bearer <token>

Bearer token for authentication.

accountIdstring required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

amountnumber required
sourceCurrencystring required
destinationCurrencystring required
senderNamestring required
receiverNamestring required
sourceCountryIsoCodestring required
destinationCountryIsoCodestring required
narrationstring
lockedExchangeRateIdstring

The exchangeRateId from a prior Fetch Exchange Rates call. When provided, the exchange is fulfilled at that exact rate.

Example request

{
  "amount": 1,
  "sourceCurrency": "USD",
  "destinationCurrency": "CDF",
  "senderName": "John Doe",
  "receiverName": "John Doe",
  "sourceCountryIsoCode": "CD",
  "destinationCountryIsoCode": "CD",
  "narration": "Transfer between my accounts",
  "lockedExchangeRateId": "01kkk4b7rh8pcvtw1s1nxs144s"
}

Response

Exchange authorized successfully.

codestring
descriptionstring

Example response

{
  "code": "00",
  "description": "Successful",
  "data": {
    "wtTransactionId": "01kkk8cjk0fpw9jx2n01wd8yfw",
    "coreTransactionId": "API-P2P-CB9EC-0c2d962e-4730-48e7-b522-d65cac511549",
    "status": "PROCESSING",
    "coreStatus": "SUCCESS",
    "type": "EXCHANGE"
  }
}