POST /api/global/payout/batch/create-order| header | ||
|---|---|---|
| Parameter | Type | Description |
| x-auth-signature | String | API signature, generated according to Lesspay authentication rules |
| x-auth-appid | String | Merchant APPID, assigned by the platform |
| X-Auth-Timestamp | String | Timestamp in milliseconds |
| Content-Type | String | Fixed as application/json |
| body | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| request_id | String | Yes | Unique merchant batch ID, unique under the same appid, ≤64 characters |
| currency | String | Yes | 3-letter target currency code (e.g., CNY, USD, PHP, BRL) |
| total_amount | String | Yes | Total batch amount (must equal sum of detail amounts, e.g., "1000.00") |
| way_type | String | Yes | Payout channel type, passed in according to the value assigned by the platform |
| way_code | String | Yes | Payout channel code, passed in according to the value assigned by the platform (e.g., TAZAPAY_PAYOUT) |
| notify_url | String | Yes | Batch result callback URL, supports http/https |
| payout_order_details | Array[Object] | Yes | Payout detail list, multiple details are supported in a single batch |
| payout_order_details[].amount | String | Yes | Unique detail ID, unique within the batch, ≤64 characters |
| payout_order_details[].destination_type | String | Yes | Target type, fixed as bank |
| payout_order_details[].bank_account_name | String | Yes | Bank card account name, sensitive field, stored encrypted by the platform |
| payout_order_details[].bank_account_no | String | Yes | Bank card number, sensitive field, stored encrypted by the platform |
| payout_order_details[].bank_account_type | String | Yes | Account type, fixed values: individual/business |
| payout_order_details[].bank_name | String | Yes | Issuing bank name (e.g., "China Merchants Bank") |
| payout_order_details[].bank_country_code | String | Yes | Issuing bank country/region code, ISO 3166-1 alpha-2 (e.g., CN, US) |
| payout_order_details[].bank_swift_code | String | Yes | Issuing bank SWIFT code, 8/11 characters, required for overseas bank cards |
| 表格 | ||
|---|---|---|
| Parameter | Type | Description |
| code | Integer | Business response code, 0 = Acceptance Success, non-0 = Acceptance Failure |
| code | Integer | Business response code, 0 = Acceptance Success, non-0 = Acceptance Failure |
| msg | String | Business response message, SUCCESS = Success |
| data | Integer | Payout batch data object |
| data.pay_order_id | Object | Lesspay platform unique batch ID |
| data.request_id | String | Batch ID submitted by the merchant |
| data.created_at | String | Batch creation time, ISO 8601 format |
| data.order_status | String | Current batch status, PENDING_CONFIRM = Awaiting Review |
| data.total_count | Integer | Number of payout details in the batch |
| data.total_amount_obj | Object | Batch total amount details |
| data.total_amount_obj.amountStr | String | Formatted total amount |
| data.total_amount_obj.currencyCode | String | Payout currency code |
| data.encryptData | String | Encrypted data, reserved field |
| data.sign | String | Response signature, reserved field |
POST /api/global/payout/batch/create-order| 表格 | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| request_id | String | Yes | Unique merchant batch ID, unique under the same appid, ≤64 characters |
| currency | String | Yes | Payout currency, 3-letter code (e.g., USD, PHP, IDR) |
| total_amount | String | Yes | Total batch amount, must be consistent with the sum of detail amounts (e.g., "200.00") |
| way_type | String | Yes | Payout channel code, passed in according to the value assigned by the platform |
| way_code | String | Yes | Payout channel code, passed in according to the value assigned by the platform (e.g., TAZAPAY_PAYOUT) |
| notify_url | String | Yes | Batch result callback URL, supports http/https |
| payout_order_details | Array[Object] | Yes | Payout detail list, multiple details are supported in a single batch |
| payout_order_details[].mch_order_id | String | Yes | Unique detail ID, unique within the batch, ≤64 characters |
| payout_order_details[].amount | String | Yes | Payout amount for a single detail (e.g., "100.00") |
| payout_order_details[].destination_type | String | Yes | Target type, fixed as ewallet |
| payout_order_details[].e_wallet | String | Yes | E-wallet information object, required nested object |
| payout_order_details[].e_wallet.account_name | String | Yes | E-wallet account name/real name |
| payout_order_details[].e_wallet.account_number | String | Yes | E-wallet account number (e.g., phone number, email address, wallet ID) |
| payout_order_details[].e_wallet.account_type | String | Yes | Wallet account type, fixed values: individual/business |
| payout_order_details[].e_wallet.provider | String | Yes | Wallet service provider name (e.g., GCash, GrabPay, PayMaya,Gopay and ShopeePay),pay attenttion diffrent currency diffrent provider for example IDR only support Gopay\ShopeePay PHP only support GCash\GrabPay\PayMaya |
| payout_order_details[].e_wallet.deposit_key_type | String | Yes | Wallet verification type, passed in according to channel requirements (e.g., cpf/cnpj/email/phone/random), CPF:Individual CPF (tax ID), CNPJ:Corporate CNPJ (tax ID), email:Email address, phon:Phone number, random:Random string |
| payout_order_details[].e_wallet.deposit_key | String | Yes | Wallet verification value, corresponding to deposit_key_type |