NOnomba

POST /v1/global-payout/exchange/authorize

Changed on

Transfer funds between your own accounts in different currencies.

Request

  • Base URL
    https://api.nomba.com
  • URL
    https://api.nomba.com/v1/global-payout/exchange/authorize
  • Auth
    none declared. Required headers: Authorization, accountId

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.

idempotencyKeystring

Optional. Your own unique key for this request. Send the same key when retrying and the original transaction is returned instead of a second one being created. A key stays tied to its transaction permanently — use a new key for a new attempt.

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",
  "idempotencyKey": "5e246f9a-3e79-4b11-92f1-dbd98b53b308"
}

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",
    "idempotencyKey": "5e246f9a-3e79-4b11-92f1-dbd98b53b308"
  }
}

Changes

  • 278a25dccfe5Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status