2.1 Create PayOut
POST /api/v1/payouts
Use this endpoint if withdrawals are enabled for your MYR shop. Obtain the recipient identifier format for that shop during onboarding.
Request
Send one JSON object with the v1 authentication headers.
| Field | Type | Required | What to send |
|---|---|---|---|
external_id | string | Yes | Your unique PayOut reference for the shop. |
amount | string | Yes | Positive MYR amount as a decimal string. |
currency | string | Yes | MYR. |
card_number | string | Yes | The recipient identifier in the format agreed for the shop. This is the v1 wire name. |
paymentData.bank_code | string | Optional | Code for the recipient's bank. Use a code supported by your payout shop. |
paymentData.holder | string | Optional | Name of the recipient account holder. |
shop_code | string | If using a non-default shop | Your assigned shop code. |
callback_url | URL | Optional | Your public HTTPS endpoint for PayOut webhooks. |
merchant_user_id, merchant_user_ip | strings | Optional | Your customer reference and the customer's IP address, when available. |
The example includes both optional fields. You can send either one on its own or omit paymentData entirely. Replace the example recipient details and shop code with your own values.
{
"external_id": "PAY-MYR-001",
"amount": "125.50",
"currency": "MYR",
"shop_code": "your_myr_shop",
"card_number": "000000123456",
"paymentData": {
"bank_code": "BANK_CODE",
"holder": "Example Recipient"
},
"callback_url": "https://merchant.example.com/webhooks/payout"
}
Response
A newly created PayOut returns 201. Example fields for tracking the operation follow.
{
"id": 12345,
"status": "pending",
"external_id": "PAY-MYR-001",
"amount": "125.50",
"currency": "MYR",
"shop_code": "your_myr_shop",
"transaction_type": "payout"
}
Store the operation ID and check its status using external_id. Retry with the same shop, identifier and original details. An equivalent repeat can return 200. Reusing the identifier for different details can return 409.