Approve - API Payout (Disbursement)
The approval process aims to request your confirmation related to the request for a transfer of funds along with the details of the NICEPAY beneficiary bank. This API uses to confirm the request from Registration - API Payout (Disbursement).
API Endpoint | /nicepay/api/direct/v2/approvePayout |
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256 (timeStamp + iMid + tXid+ merchantKey) |
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | API Request Date | 20221219085959 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST07202212191238107952 |
iMid Required | AN | 10 | Merchant Id | IONPAYTEST |
merchantToken Required | AN | 255 | merchant Token | 9f33948e1ce99b6f42c2a223234ec50ff1bc450c78a16885227c57fae4f4ff80 |
If ever got a timeout during the Approve process to NICEPAY, the Merchant hopefully doesn't treat the transaction status as success or failed, but suspect. Because the fund deduction already proceeds on this transaction status.
Transactions that are considered suspect will still be processed, and only need extra time. After the process finishes, the Merchant will get that final notification status from the registered callback URL to NICEPAY.
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 4 | 0000 | |
resultMsg | AN | 10 | Result Message: Error Code | Success |
tXid | AN | 30 | Payout Transaction Id (Key from NICEPAY) | IONPAYTEST07202212191238107952 |
iMid | AN | 10 | Merchant Id | IONPAYTEST |
referenceNo | ANS | 40 | Merchant Order No (Key from merchant) | ORD12345 |
amt | N | 12 | Payout amount | 1000 |
transDt | N | 8 | Transaction date (YYYYMMDD) | null |
transTm | N | 6 | Transaction time (HH24MISS) | null |
accountNo | N | 20 | Beneficiary Account No | 5345000060 |
benefNm | AN | 40 | Beneficiary Name | PT IONPAY NETWORKS |
bankCd | AN | 4 | BDIN | |
validDate Only For Cashout | N | 8 | Valid Token Date (YYYYMMDD) | 20220819 (Default D+1) |
validTm Only For Cashout | N | 6 | Valid Token Time (HH24MISS) | 131207 (Default D+1) |
cashoutToken Only For Cashout | N | 20 | Valid Token Time (HH24MISS) | 2070520843 |
mCode Only For Cashout | AN | 40 | Generate Token by NICEPAY | NICEPAY CASHOUT TEST |