Payout
Create
Special Notes:
-
When calling the payout API, network timeouts or unknown exceptions (with a response code of 5000) may occur. In such cases, the result of the transaction is unknown, and it is necessary to query the payout order status later to obtain the latest update.
-
If a network timeout occurs, you may retry after 2 minutes.
Request URL
https://gateway.pay247.io/gateway/payout/create
Request Method
- POST
Request Parameters
Parameter | Must | Type | Explanation |
---|---|---|---|
mch_id | Yes | string | Merchant ID |
mch_order_no | Yes | string | Merchant Order NO. |
currency | Yes | string | Currency [PHP, JPY, INR, USD…] |
amount | Yes | string | Amount |
pay_method | Yes | string | Payment method |
account_name | Yes | string | Accouont Name |
account_no | Yes | string | Account No. |
notify_url | No | string | Notify URL |
bank_code | No | string | 【OPTIONAL】Bank Code for pay_method = bank |
bank_branch | No | string | 【OPTIONAL】Bank Branch |
timestamp | Yes | string | timestamp millisecond |
version | Yes | string | v1.0 |
uuid | Yes | string | Request ID: 550e8400-e29b-41d4-a716-446655440000 |
sign | Yes | string | Signatrue |
Response data
Parameter | Must | Type | Explanation |
---|---|---|---|
mch_id | Yes | string | Merchant ID |
mch_order_no | Yes | string | Merchant Order NO. |
order_no | Yes | string | Order NO. |
currency | Yes | string | CNY、 THB、PHP、VND… See more at backoffice |
amount | Yes | string | Amount |
fee | Yes | string | Fee |
status | Yes | status | PENDING, DEALING, CLOSED, SUCCESS, FAIL |
paid_at | No | string | if the order SUCCESS, will have paid time |
error | No | string | if the order FAIL, maybe have error info |
For example
Indian(INR)Payout Request Parameters
Parameter | Must | Type | Explanation |
---|---|---|---|
mch_id | Yes | string | Merchant ID. |
mch_order_no | Yes | string | Merchant Order No. |
currency | Yes | string | Currency: PHP |
amount | Yes | string | Amount |
pay_method | Yes | string | Payment Method: BANK |
account_no | Yes | string | Account No. |
bank_code | Yes | string | IFSC |
notify_url | 否 | string | Notify URL |
timestamp | Yes | string | Timestamp millisecond |
version | Yes | string | Version: v1.0 |
uuid | Yes | string | Request ID: 550e8400-e29b-41d4-a716-446655440000 |
sign | Yes | string | Signatrue |
Philippine(PHP)Payout Request Parameters
Parameter | Must | Type | Explanation |
---|---|---|---|
mch_id | Yes | string | Merchant ID. |
mch_order_no | Yes | string | Merchant Order No. |
currency | Yes | string | Currency: PHP |
amount | Yes | string | Amount |
pay_method | Yes | string | Payment Method: BANK |
account_no | Yes | string | Account No. |
bank_code | Yes | string | Bank Codes |
notify_url | 否 | string | Notify URL |
timestamp | Yes | string | Timestamp millisecond |
version | Yes | string | Version: v1.0 |
uuid | Yes | string | Request ID: 550e8400-e29b-41d4-a716-446655440000 |
sign | Yes | string | Signatrue |