Create Crypto Payout
POST
/api/v1/payments/payout/crypto
Last modified:2026-07-16 11:55:25
| Field | Type | Description | Constraints |
|---|---|---|---|
customerWalletId | string (uuid) | Merchant wallet to debit | Required |
fromValue | number (double) | Amount in the source asset | Required |
productId | string (uuid) | Product identifier | Nullable |
payeeId | string (uuid) | Payee identifier | Nullable |
requestedAmount | number (double) | Requested payout amount | Nullable |
receivedAmount | number (double) | Amount the payee receives | Nullable |
finalAmount | number (double) | Final amount after fees | Nullable |
quoteId | string | Quote from the fee endpoint | Nullable |
fiatCurrency | string | Fiat currency code | Nullable |
purpose / purposeCode | string | Payment purpose | Nullable |
sourceOfFunds / sourceOfFundsCode | string | Source of funds | Nullable |
beneficiaryRelationship | string | Relationship to beneficiary | Nullable |
moduleType | string | Originating module | Nullable |
paymentType | string | Payment type | Nullable |
nationalIdNumber | string | Beneficiary national ID | Nullable |
fromAssetId / fromAsset | uuid / string | Source asset | Nullable |
toAssetId / toAsset | uuid / string | Destination asset | Nullable |
toValue | number (double) | Amount in destination asset | Nullable |
metadata | string | Free-form metadata | Nullable |
docRepositories | array | Supporting documents (id, fileName, docType, blobFileName, state) | Nullable |
Request
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/payments/payout/crypto' \
--header 'X-Idempotency-Key: c8f7b2e1-3d4e-5f6a-9b0c-1d2e3f4a5b6c' \
--header 'authinformation;' \
--header 'Content-Type: application/json' \
--data '{
"customerWalletId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"productId": "1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d",
"payeeId": "9b2f1c44-8a31-4f0d-9d6e-1c2b3a4d5e6f",
"requestedAmount": 1500,
"finalAmount": 1487.5,
"quoteId": "qt_8f3a9b2c",
"fiatCurrency": "USD",
"purpose": "Family Support",
"purposeCode": "FAM",
"sourceOfFunds": "Business Income",
"sourceOfFundsCode": "BIZ",
"paymentType": "crypto",
"fromAssetId": "7d8e9f0a-1b2c-4d5e-8f9a-0b1c2d3e4f5a",
"fromAsset": "USDT",
"toAsset": "USD",
"fromValue": 1512.5,
"toValue": 1500,
"metadata": "order-4491",
"docRepositories": [
{
"id": "5e6f7a8b-9c0d-4e2f-8a3b-4c5d6e7f8a9b",
"fileName": "invoice-4491.pdf",
"docType": "invoice",
"blobFileName": "blob/invoice-4491.pdf",
"state": "uploaded"
}
]
}'Response Response Example
{
"payoutId": "0f1e2d3c-4b5a-4968-8776-655443322110",
"status": "processing",
"createdAt": "2026-07-16T10:32:00Z"
}Modified at 2026-07-16 11:55:25