Skip to main content
POST
cURL

Create Remittance Payout

Error Codes and Messages

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json
quotation_id
string<uuid>
required

The unique identifier of the quotation, obtained from POST /remittance-payout/quotation

Example:

"2e104290-07c8-49f1-a5ca-0d27f0078f8a"

customer_id
string<uuid>
required

The unique identifier of the customer

Example:

"def8b740-99f9-4cba-bc9e-99de57e927b4"

remitter_id
string<uuid>
required

The unique identifier of the remitter, obtained from POST /kyc/remitter/create. Stored on the payout for record-keeping and echoed back in the response; not sent to any partner call.

Example:

"e14fa86f-2a5e-437a-a031-949c68ade933"

client_reference_id
string

Optional client reference ID for tracking.

Example:

"testUser123"

transaction_hash
string

On-chain transaction hash of the crypto deposit. Required for organizations not on the prefunding flow; omit on the prefunding flow (the payout debits the prefunded balance).

Example:

""

Response

Remittance payout created successfully

status
boolean
Example:

true

message
string
Example:

"Success"

data
object