Payouts
Fiat to Crypto Payout

Off Ramp – Create Fiat Payout Transaction

This endpoint initiates a fiat payout transaction, sending funds to a recipient’s bank account.

Endpoint

POST {{baseURL}}/v1/ramp/payout

Headers

HeaderValueRequired
x-api-keyYOUR_API_KEYYes

Request Body

{
  "recipient": {
    "id": "",
    "name": "",
    "address": "",
    "email": "",
    "website": "",
    "type": "<i.e PERSON/BUSINESS>",
    "account": {
      "bankName": "",
      "address": "",
      "accountNumber": "",
      "sortCode": "",
      "swiftCode": "",
      "branchCode": "",
      "routingNumber": "",
      "mobileProvider": ""
    }
  },
  "quoteId": "<quoteId>",
  "reason": "",
  "remark": ""
}

Field Descriptions

FieldTypeDescription
recipient.idstringRecipient ID (if available)
recipient.namestringRecipient’s name
recipient.addressstringRecipient’s address
recipient.emailstringRecipient’s email (if available)
recipient.websitestringRecipient’s website (optional)
recipient.typestring"PERSON" or "BUSINESS"
recipient.account.bankNamestringBank name
recipient.account.addressstringBank branch address (optional)
recipient.account.accountNumberstringBank account number
recipient.account.sortCodestringBank sort code (if applicable)
recipient.account.swiftCodestringSWIFT code (for international transfers)
recipient.account.branchCodestringBank branch code (optional)
recipient.account.routingNumberstringRouting number (if applicable)
recipient.account.mobileProviderstringMobile provider (if using mobile money)
quoteIdstringID of the quote to finalize payout details
reasonstringReason for the transaction
remarkstringAdditional notes or description for the transaction

Successful Response 200 OK

{
  "message": "transaction created successfully",
  "status": "success",
  "data": {
    "id": "bc1ac02d-2b9c-435f-9b7a-xxxxxxxxxxxxx",
    "referenceNumber": "XYORKSXAUJRYJ",
    "state": "PENDING",
    "created": "2023-05-05T13:21:54.197217",
    "processed": "2023-05-05T13:21:54.197217"
  }
}

Error Codes

CodeMessage
400Bad request – invalid or missing fields
401Unauthorized – invalid API key or token
500Internal server error

Additional Notes

  • Use a valid quoteId to ensure the payout uses the correct exchange rates and fees.
  • The recipient.account section must contain valid banking details for the payout.
  • Always verify the state field (PENDING, COMPLETED, FAILED) in the response to track payout status.
  • All sensitive requests must include the required headers for secure authorization.
Crypto to Crypto PayoutGet Transaction (Crypto and Off-Ramp)