Create Withdrawal Order (Japan)
API for creating Japanese Yen (JPY) withdrawal orders.
Request Information
- Request URL:
/gateway/api/v2/payouts - Method:
POST - Content-Type:
application/json;charset=utf-8
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| platform_id | Yes | String(6) | Merchant ID |
| service_id | Yes | String(7) | Service ID |
| payout_cl_id | Yes | String(64) | Merchant Order ID |
| amount | Yes | Integer(10) | Amount (in cents) |
| notify_url | No | String(256) | Callback URL for transaction results |
| bank_name | Yes | String(16) | Bank code |
| name | Yes | String(16) | Beneficiary name |
| number | Yes | String(32) | Beneficiary account number |
| currency | Yes | String(3) | Fixed value: jpy |
| request_time | Yes | Integer(10) | Request time (seconds) |
| sign_type | No | String(16) | Signature type: HMAC-SHA256 (recommended) or MD5 (default) |
| sign | Yes | String(32|64) | Order Signature |
Service ID
SVC0004Bank Card Withdrawal
Response Example
{
"error_code": "0000",
"data": { "payout_id": "POT00000001" }
}
Remarks
Important
In case of timeout or HTTP 500 errors, please use the order query API to check the status. Do not treat the order as failed directly.
- Transaction amount is in Japanese Yen (cents)
- A response of "0000" only indicates the API call was successful. Please use the query API to confirm the result