Skip to main content

2.1 Create PayOut

POST /api/v1/payouts

Request

ParameterTypeRequiredDescription
X-API-KeystringYesAPI key.
X-TimestampstringYesRequest time in ISO-8601 UTC format.
X-SignaturestringYesHMAC-SHA256(timestamp + body, secret).
Content-TypestringYesapplication/json.

Example request

{
"external_id": "POUT-VND-EPT-001",
"amount": "250000",
"currency": "VND",
"card_number": "0123456789",
"paymentData": {
"bank_code": "VCB",
"holder": "Nguyen Van An"
},
"shop_code": "your_ept_vnd_shop",
"merchant_user_id": "merchant-user-001",
"callback_url": "https://merchant.example.com/webhooks/payout"
}

Response

Response fields

Fields with null values are omitted from the response.

ParameterTypeDescription
idnumberPayfield operation ID.
statusstringCurrent PayOut status.
external_idstringUnique PayOut identifier from the request.
amountstringPayOut amount.
currencystringVND.
shop_codestringShop code used for routing.
card_numberstringRecipient bank-account number from the request.
merchant_user_idstringMerchant user identifier from the request.
merchant_user_ipstringUser IP from the request, when supplied.
callback_urlstringCallback URL from the request, when provided.
transaction_typestringAlways payout.
created_atstringCreation timestamp.
updated_atstringLast update timestamp.
finalization_datestringReturned when the PayOut reaches a final status.

Example response

{
"id": 12346,
"status": "pending",
"external_id": "POUT-VND-EPT-001",
"amount": "250000",
"currency": "VND",
"shop_code": "your_ept_vnd_shop",
"card_number": "0123456789",
"merchant_user_id": "merchant-user-001",
"transaction_type": "payout",
"created_at": "2026-09-21T10:00:00+00:00",
"updated_at": "2026-09-21T10:00:00+00:00"
}