Withdrawals
Get & List Withdrawals
GET /v1/withdrawals/:id to get one (caller-scoped) and GET /v1/withdrawals to list your own withdrawals
GET /v1/withdrawals/:id · GET /v1/withdrawals
Read a single withdrawal request or list your own. Both are bodyless, HMAC-signed (S2S), and scoped to the calling merchant only.
Get one — GET /v1/withdrawals/:id
Returns a withdrawal request only for your own merchant. If id is not yours / not found / has an invalid format → 404 (existence is not revealed).
Example request
curl "https://api.unkpay.co/v1/withdrawals/3b9c1e54-2a77-4f0d-bb1e-8a6d4c2e91aa"
Pending confirmation — add the S2S authentication headers (API key + HMAC signature)
Response body — 200 OK
| Field | Type | Description |
|---|---|---|
id | string (uuid) | Withdrawal id. |
amount | string (baht) | Amount the destination receives. |
fee | string (baht) | Fee. |
net_payout | string (baht) | Net amount paid to the destination. |
currency | string | "THB" |
receiver_bank_provider | string | Destination bank code. |
destination | object | { "bank", "account_no", "name" } full plaintext. |
kind | string | "customer" |
reference_user_id | string | Destination customer reference id (only if sent at create). |
status | string | Current status — `PENDING |
created_at | string (timestamp) | Time the request was created. |
{
"id": "3b9c1e54-2a77-4f0d-bb1e-8a6d4c2e91aa",
"amount": "500.00",
"fee": "9.00",
"net_payout": "500.00",
"currency": "THB",
"receiver_bank_provider": "SCB",
"destination": {
"bank": "SCB",
"account_no": "1234567890",
"name": "สมชาย ใจดี"
},
"kind": "customer",
"reference_user_id": "cust-7",
"status": "PENDING",
"created_at": "2026-06-19T10:38:00Z"
}
reference_user_id appears only if it was sent in additional.reference_user_id at create time. Status is the source of truth for the current state, but the terminal outcome must still be confirmed via the terminal webhook.List your own — GET /v1/withdrawals
Returns the list of withdrawal requests for the calling merchant only (caller-scoped). The response is an array of withdrawal objects with the same fields as the single-get above.
Example request
curl "https://api.unkpay.co/v1/withdrawals"
Pending confirmation — add the S2S authentication headers (API key + HMAC signature)
Errors
| HTTP | code | Cause |
|---|---|---|
404 | NOT_FOUND | (single get) id is not yours / not found / has an invalid id format |
See the Error Envelope & Codes for the cross-cutting error format.