Registration - API Payout (Disbursement)
Registration - API Payout (Disbursement) process is the initial process on proceeding the fund transfer into the destination account. This API aims to register the payout transaction request from You to NICEPAY.
NICEPAY urges You to ensure that your payout balance is sufficient before proceeding with this payout registration process by using Check Balance - API Payout (Disbursement) API so the payout process able to going smoothly.
If your payout balance is insufficient, please proceed with a fund deposit firsthand on your Payout balance. Please check the Balance Deposits page to view further related information.
API Endpoint | /nicepay/api/direct/v2/requestPayout |
Request Method application/json | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256(timestamp + iMid + amt + AccountNo + merchantKey) |
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | API Request Date | 20221219085959 |
iMid Required | AN | 10 | Merchant Id | IONPAYTEST |
msId | AN | 30 | Merchant Seller Id | SELLER0001 |
amt Required | N | 12 | Payout Amount | 1000 |
merchantToken Required | AN | 64 | Merchant Token | b252d9f89a448d94e163e913a47b4d5c4c0af82a39b951e18eccdb3d28f59bbf |
accountNo Required | N | 20 | Beneficiary Account No | 5345000060 |
referenceNo Required | AN | 40 | Reference Number | ORD12345 |
bankCd Required | N | 4 | BDIN | |
benefNm Required | AN | 40 | Beneficiary Name | PT IONPAY NETWORKS |
benefPhone Required | N | 12 | Beneficiary Phone | 082111111111 |
benefStatus Required | N | 2 | Beneficiary Status: 1: WNI 2: WNA | 1 |
benefType Required | N | 2 | Beneficiary Type 1: Personal 2: Company 3: Government | 1 |
reservedDt | N | 8 | Schedule Date (YYYYMMDD) | |
reservedTm | N | 6 | Schedule Time (HH24MISS) | |
description | AN | 100 | Payment Notification | This is test |
payoutMethod Required | N | 2 | | |
benefPOE | ANS | 50 | Beneficiary place of establishment | Kota Administrasi Jakarta Selatan Mandatory For transactions above 100 million Only for benefType 2 & 3 |
benefDOE | N | 8 | Beneficiary date of establishment | 220101 YYYYMMDD Mandatory For transactions above 100 million Only for benefType 2 & 3 |
benefCoNo | ANS | 30 | Beneficiary business license number (NIB/TDB) | 12345JP Mandatory For transactions above 100 million Only for benefType 2 & 3 |
benefAddr | ANS | 255 | Beneficiary company address | Jl. Hong Gil Dong, 88 Mandatory For transactions above 100 million Only for benefType 2 & 3 |
benefMerCategory | N | 2 | Beneficiary Merchant Category | 01 Mandatory For transactions above 100 million Only for benefType 2 & 3 Refer list table Merchant Code for values |
benefAuthPhoneNumber | NS | 20 | Beneficiary Authorized Phone Number | 081623516151725378 Mandatory For transactions above 100 million Only for benefType 2 & 3 |
benefCoMgmtNm | ANS | 100 | Beneficiary Company Management Name | John Doe Mandatory For transactions above 100 million Only for benefType 2 & 3 |
benefCoShNm | ANS | 255 | Beneficiary Company Shareholder Name | John Doe Mandatory For transactions above 100 million Only for benefType 2 & 3 |
deliveryNm | ANS | 100 | Name of the beneficiary or recipient | Ciki Mandatory For transactions above 100 million |
deliveryId | ANS | 20 | Recipient's identification number such as ID card, passport, driving license. | 123 Mandatory For transactions above 100 million |
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 4 | 0000 | |
benefNm | AN | 40 | Beneficiary Name | PT IONPAY NETWORKS |
resultMsg | AN | 255 | result message: Error Code | SUCCESS |
tXid | AN | 30 | Payout Transaction ID (Key from NICEPAY) | IONPAYTEST07202212191238107952 |
referenceNo | AN | 40 | Reference No (Key from merchant) | ORD1234 |
payoutMethod | N | 2 | 0 | |
amt | N | 12 | Payout amount | 10000 |
accountNo | N | 20 | Beneficiary Account No | 123456789 |
payoutToken | AN | 100 | Payout Token | null |
bankCd | AN | 4 | IDMC |