NICEPAY API
...
API Versi 2
Payout API (Disbursement)

Registration - API Payout (Disbursement)

8min

Tentang Registration - API Payout (Disbursement)



Proses Registration - API Payout (Disbursement) merupakan proses pertama dalam menjalani proses pengiriman dana ke rekening tujuan. API ini bertujuan untuk mendaftarkan sebuah request untuk suatu transaksi Payout dari Anda ke NICEPAY.

NICEPAY menghimbau Anda untuk memastikan saldo Payout sudah cukup sebelum melakukan proses Payout registration ini dengan menggunakan API. Check Balance - API Payout (Disbursement) agar proses Payout berjalan dengan lancar.

Apabila saldo Payout tidak cukup, silakan lakukan deposit dana terlebih dahulu pada balance Payout Anda. Silakan kunjungi halaman Deposit Saldo untuk melihat rincian informasi terkait.



Registration - API Payout (Disbursement)



API Endpoint

/nicepay/api/direct/v2/requestPayout

Request Method

POST

Header

Content-Type: application/json

Merchant Token

SHA256(timestamp + iMid + amt + AccountNo + merchantKey)



Request Parameter for Payout Registration



Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

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 Number

5345000060

referenceNo

Required

AN

40

Reference Number

ORD12345

bankCd

Required

N

4

Bank Code

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

0: Overbooking

1: Online

2: SKN

3: RTGS

4: Cashout



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 transaction 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



Response Parameter for Payout Registration



Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

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 Number (Key from Merchant)

ORD1234

payoutMethod

N

2

Payout Method

0: Overbooking

1: Online

2: SKN

3: RTGS

4: Cashout

0

amt

N

12

Payout Amount

10000

accountNo

N

20

Beneficiary Account Number

123456789

payoutToken

AN

100

Payout Token

null

bankCd

AN

4

Bank Code

IDMC



Sample JSON for Payout Registration


JSON Request
JSON Response
Java Request