Create Payout
Create a payout request to selected beneficiary account.
This endpoint initiates a fund transfer from your virtual pool to a recipient’s bank account using a registered payout provider. Once created, the payout will enter a pending or processing state depending on bank handling times.
Use this endpoint after retrieving available payout providers via Payout Provider.
Endpoint
POST
https://api.payright.my/api/v1/merchant/payout
Usage Examples
curl -X POST "https://api.payright.my/api/v1/merchant/payout" \
-H "auth-token: eyJhbGciO...XZI3CLi_a0BeUOJMPUK00" \
-H "Content-Type: application/json" \
-d '{
"virtual_pool_reference": "VA-ABC-1234-PAYOUT",
"payout_service_id": 14,
"amount": 10.20,
"client_redirect_url": "https://www.example.com/redirect",
"client_callback_url": "https://www.example.com/callback",
"third_party_account_no": "12345678901",
"recipient_reference": "john_doe",
"payment_description": "June Payout",
"external_invoice_ref": "INV-0123"
}'
Authentication
string
header
required
To authenticate requests, include an Authorization header with the value
Key
Value
auth-token
<Your Payright auth token>
Request
Body
application/json
{
"virtual_pool_reference": "VA-AE81DE-120345369538-PAYOUT",
"payout_service_id": 14,
"amount": 24.50,
"client_redirect_url": "https://www.payright.my/ms",
"client_callback_url": "https://webhook.site/36d8f28e-972c-4777-b574-bbd9d96e4949",
"third_party_account_no": "12345678901",
"recipient_reference": "test3",
"payment_description": "test payment description3",
"external_invoice_ref": "Payright03"
}
Request Attributes
Response
application/json
{
"status": "ok",
"code": 2000,
"data": {
"status": "SUCCESS",
"invoice_no": "po-6DC1:125037-pyt"
},
"uuid": "408ed601-0cf9-4835-9bef-f734410741dc",
"message": null,
"error": null
}
Response Attributes
Last updated