Create PAYOUT
Endpoint
- Method:
POST - Path:
/v1/payouts - Purpose: Create a payout transaction
- Optional Header:
Idempotency-Key
Request Payload
| Field | Type | Required | Description |
|---|---|---|---|
amount | string (numeric) | Yes | Transaction amount |
benificiaryAccountInfo | object | Yes | Beneficiary account info |
benificiaryAccountInfo.number | string | Yes | Wallet/account number |
benificiaryAccountInfo.orgId | string | Yes | Organization id (e.g. BKASH) |
benificiaryAccountInfo.orgCode | string | Yes | Organization code |
benificiaryAccountInfo.orgName | string | Yes | Organization name |
benificiaryAccountInfo.holderName | string | Yes | Beneficiary name |
cardHolderInfo | object | Yes | Card/sender identity object |
cardHolderInfo.firstName | string | Yes | First name |
cardHolderInfo.lastName | string | Yes | Last name |
cardHolderInfo.email | string | Yes | |
cardHolderInfo.phone | string | Yes | Phone |
Example Payload
{
"amount": "100",
"benificiaryAccountInfo": {
"number": "01712345678",
"orgId": "BKASH",
"orgCode": "BKASH",
"orgName": "BKASH",
"holderName": "John Doe"
},
"cardHolderInfo": {
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"phone": "01712345678"
}
}Response
Success (200)
| Field | Type | Description |
|---|---|---|
transactionId | string | Transaction identifier |
status | string | Usually pending initially |
amount | string | Requested amount |
platformOrderId | string | Platform order reference |
recipient | object | Recipient info |
recipient.masked | string | Masked destination number |
estimatedCompletion | string (ISO datetime) | Estimated completion time |
{
"transactionId": "uuid",
"status": "pending",
"amount": "100",
"platformOrderId": "...",
"recipient": { "masked": "****5678" },
"estimatedCompletion": "..."
}