Skip to main content
This endpoint allows you to process payouts in US Dollars (USD) to recipients with a bank account in the United States.

​
Endpoint

POST: {{baseURL}}/v2/payout

​
Supported Payment Channels

USD payouts support two payment channels:
ChannelDescriptionUse Case
SWIFTInternational wire transfer using SWIFT codeInternational/Cross-border transfers

​
Request Details

​
Headers

Include these headers in your request:
HeaderValueRequired
Content-Typeapplication/json✅ Yes
x-api-keyYOUR_API_KEY✅ Yes

​
Sample Requests

Use SWIFT for international wire transfers using SWIFT/BIC codes.
curl --location --request POST '{{baseURL}}/v2/payout' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "recipient": {
    "name": "James Wilson",
    "nickName": "Blue",
    "gender": "M",
    "occupation": "business entrepreneur",
    "type": "BUSINESS",
    "account": {
      "sortCode": "02090",
      "swiftCode": "GTBINGLA",
      "bankCity": "Atlanta",
      "accountNumber": "885406477269",
      "bankName": "DBS Bank Limited",
      "intermediarySwiftCode": "CHASUS33XXX"
    },
    "paymentChannel": "SWIFT",
    "country": "US",
    "currency": "USD"
  },
  "quoteId": "859b19e8-8a00-4d59-9970-xxxxxxxxxxxxx",
  "reason": "Gift",
  "invoice": "4b9b6d30-a2ed-421a-bd69-11536344f071",
  "remark": "Testing"
}'

​
Request Body Breakdown

FieldTypeDescriptionRequired
quoteIdStringThe unique ID of the quote for this payout.✅ Yes
reasonStringThe purpose of the transfer (e.g., Gift, Payment for services).✅ Yes
invoiceStringOptional identifier for the invoice (returned from file upload).❔ No
remarkStringAn optional, additional note about the transaction.❔ No
recipientObjectAn object containing all details about the person receiving the funds.✅ Yes
recipient.nameStringThe full name of the recipient or business.✅ Yes
recipient.nickNameStringA nickname or alias for the recipient.❔ No
recipient.genderStringGender of the recipient. Enum: M, F.❔ No
recipient.occupationStringThe recipient’s occupation or profession.❔ No
recipient.typeStringThe type of recipient. Enum: INDIVIDUAL, BUSINESS.✅ Yes
recipient.paymentChannelStringThe payment method. Use SWIFT for international wire transfers.✅ Yes
recipient.currencyStringThe ISO currency code. Must be USD.✅ Yes
recipient.countryStringThe recipient’s two-letter ISO country code. Must be US.✅ Yes
recipient.accountObjectAn object containing the recipient’s bank account details.✅ Yes
recipient.account.accountNumberStringThe recipient’s bank account number.✅ Yes
recipient.account.swiftCodeStringThe SWIFT/BIC code of the recipient’s bank.✅ Yes
recipient.account.sortCodeStringThe bank sort code.❔ No
recipient.account.bankNameStringThe name of the recipient’s bank.✅ Yes
recipient.account.bankCityStringThe city where the bank is located.❔ No
recipient.account.intermediarySwiftCodeStringThe SWIFT/BIC code of the intermediary bank.❔ No (Conditional)

​
Success Response (200 OK)

If the payout is successfully created, the API returns the following response:
copy
{
  "message": "Transaction created successfully",
  "status": "success",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-xxxxxxxxxxxxx",
    "invoice": "4b9b6d30-a2ed-421a-bd69-11536344f071",
    "reason": "Gift",
    "referenceNumber": "TXYZD6RWSQMKF",
    "type": "SEND",
    "state": "COMPLETED",
    "quote": {
      "id": "859b19e8-8a00-4d59-9970-xxxxxxxxxxxxx",
      "source": {
        "currency": "NGN",
        "country": "NG",
        "amount": 160000
      },
      "target": {
        "currency": "USD",
        "country": "US",
        "amount": 100
      },
      "rate": 1600,
      "fee": {
        "amount": 500
      }
    },
    "recipient": {
      "name": "Linda Collins",
      "type": "BUSINESS",
      "address": "200 Koch Vista, New York, NY 10001",
      "account": {
          "accountNumber": "8573629XX",
          "swiftCode": "1234",
          "bankName": "Chase Bank",
          "address": "1948 Kemmer Ville, New York, NY 10002",
          "routingNumber": "0210000XX"
      },
      "paymentChannel": "SWIFT",
      "currency": "USD",
      "country": "US"
    },
    "created": "2025-02-27T14:17:48.038044Z",
    "processed": "2025-02-27T14:20:49.712685Z"
  }
}

​
Response Breakdown

FieldTypeDescription
messageStringA confirmation message indicating the result of the request.
statusStringThe overall status of the request, e.g., success.
dataObjectA container for all the transaction data.
data.idStringThe unique identifier for this payout transaction.
data.reasonStringThe reason for the payout provided in the request.
data.invoiceStringOptional identifier for the invoice provided in the request.
data.referenceNumberStringA unique reference number generated for the payout.
data.typeStringThe type of transaction, e.g., SEND.
data.stateStringThe current state of the payout (COMPLETED, PENDING, etc.).
data.quote.idStringThe unique ID of the quote used for the transaction.
data.quote.source.currencyStringThe three-letter currency code of the source funds.
data.quote.target.amountNumberThe converted amount that the recipient received.
data.recipient.nameStringThe full name of the recipient.
data.recipient.typeStringThe type of recipient entity, e.g., BUSINESS.
data.recipient.account.accountNumberStringThe recipient’s bank account number.
data.recipient.account.bankNameStringThe name of the recipient’s bank.
data.recipient.account.swiftCodeStringThe swift code of the recipient’s bank.
data.createdStringISO 8601 timestamp of when the transaction was created.
data.processedStringISO 8601 timestamp of when the transaction was processed.

​
Payout Transaction States

The payout transaction can have one of the following states:
StateDescription
COMPLETEDThe payout was successfully processed.
PENDINGThe payout is still being processed.
FAILEDThe payout failed to process.
REFUNDEDThe payout has been sent back to sender.

​
Error Handling

Status CodeMeaningExample Response
400Insufficient BalanceInsufficient Balance
401UnauthorizedInvalid API key provided.
403ForbiddenIP not whitelisted
404Not FoundThe requested endpoint does not exist.
422Unprocessable EntityInvalid quote ID provided.
500Internal Server ErrorAn internal error occurred.

​
Best Practices

✅ Ensure quoteId is valid and linked to an existing quote.
✅ Confirm that the recipient’s bank account number and bank code are correct.
✅ Use SWIFT for international wire transfers requiring SWIFT/BIC codes.
✅ Use a valid API key in the headers.
✅ Handle error responses correctly in your integration.
Testing Failed Payouts: In the sandbox environment, you can simulate a failed payout by setting "remark": "fail" in your request. This triggers a payout.failed webhook, allowing you to test your error handling.