Create Payout

POST

/api/v1/payout/create

Initiate an international payout to a beneficiary bank account. Fees are deducted from the payment amount.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Payout created successfully

Bodyapplication/json

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/payout/create' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "currency": "string",
    "amount": 0,
    "beneficiaryId": "string",
    "purposeCode": "string",
    "payoutReference": "string",
    "payoutDate": "string",
    "description": "string"
}'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "success",
    "data": {
        "transactionNo": "string",
        "payoutId": "string",
        "shortReferenceId": "string",
        "payoutStatus": "string",
        "currency": "string",
        "amount": 0,
        "systemFee": 0,
        "actualSendAmount": 0,
        "beneficiaryId": "string",
        "payoutReference": "string",
        "purposeCode": "string",
        "payoutDate": "string",
        "idempotencyKey": "string",
        "createTimeUtc": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-05-27 09:47:15

Get Balance by Currency

Unified Webhook Entry