Payouts
A payout sends money from your available balance to a Philippine bank account or e-wallet. You can create them from the dashboard or with the API.
Create a payout
POST /v1/payoutsJSON
{
"merchant_payout_id": "PO-5521",
"amount": "1000.00",
"channel": "BANK",
"bank_code": "BDO",
"account_number": "001234567890",
"account_name": "Juan Dela Cruz",
"email": "[email protected]"
}| Field | Type | Required | Description |
|---|---|---|---|
merchant_payout_id | string | Yes | Your reference, unique within your account. |
amount | string | Yes | In pesos, inside your payout limits. |
channel | string | Yes | BANK for any bank or e-wallet rail, GCASH for GCash numbers. |
bank_code | string | BANK | From GET /v1/banks. |
account_number | string | Yes | Bank account number, or a GCash number 09XXXXXXXXX. |
account_name | string | Yes | Name on the account. |
callback_url | string | No | Webhook URL for this payout only. |
Holds and fees
The amount plus the payout fee is held from your available balance the moment the payout is created; the response shows fee and total_debit. If the payout fails or is rejected, the hold is released by itself.
Large payouts can wait for approval
Payouts above your approval threshold start as APPROVAL_PENDING until your account admin approves them.
Statuses
| Status | Meaning |
|---|---|
APPROVAL_PENDING | Waiting for an approval (above the threshold). |
PROCESSING | Sent to the bank or e-wallet. |
SUCCEEDED | Delivered. |
FAILED | Not delivered; the hold is released. |
REJECTED | Declined at approval; the hold is released. |