Registration - API Payout (Disbursement) SNAP

7min

About Registration - API Payout (Disbursement) SNAP
﻿
This API with SNAP standards uses to register the Payout or Disbursement transaction before executing the transaction process.
﻿
Registration - API Payout (Disbursement) SNAP
﻿
Please request the access token firsthand before performing the authentication through the Request Access Token API - SNAP﻿ section.
API Endpoint
﻿/nicepay/api/v1.0/transfer/registration﻿
HTTP Method
POST
Description
Create Transaction Payout or Disbursement
Content-type
application/json
﻿
Request Registration Payout (Disbursement) Header Parameter
Parameter
Type
Length
Required
Description
Remarks
Content-Type
String
127
Mandatory
Content type, value always application/json
﻿
Authorization
String
Variable
Mandatory
Bearer “accessToken”
﻿
X-TIMESTAMP
String
25
Mandatory
Using ISO 8601 as timestamp format.
Transaction date time, in format YYYYMMDDTHH:mm:ss+07:00.
Time must be in GMT+7 (Jakarta time).
2022-03-21T10:11:40+07:00.
﻿
X-SIGNATURE
String
Variable
Mandatory
Signature will be generated by Merchant.
﻿Panduan X-Signature - Symmetric﻿﻿
﻿
X-PARTNER-ID
String
20
Mandatory
Unique Partner ID, Partner ID = Client ID
﻿
X-EXTERNAL-ID
String
40
Mandatory
Unique messaging Reference ID generated by Merchant. Numeric String. Reference number that should be unique in every transaction.
﻿
CHANNEL-ID
String
5
Mandatory
Unique Channel Merchant Credential ID Number.
Client ID + "01" =  Channel ID 
"IONPAYTEST" + "01" = "IONPAYTEST01" 
IONPAYTEST01
﻿
Request Registration Payout (Disbursement) Body Parameter
Parameter
Type
Length
Required
Description
partnerReferenceNo
String
40
Mandatory
Transaction ID from Merchant
merchantId
String
10
Mandatory
Merchant identifier that is unique per each Merchant
msId
String
20
Optional
Merchant Seller ID
beneficiaryAccountNo
String
25
Mandatory
Beneficiary Account Number
beneficiaryName
String
100
Mandatory
Beneficiary Name
beneficiaryPhone
String
20
Mandatory
Beneficiary Phone
beneficiaryCustomerResidence
String
2
Mandatory
Beneficiary Customer Residence:
1: Indonesia
2: Non Indonesia
beneficiaryCustomerType
String
2
Mandatory
Beneficiary Customer Type:
1: Personal
2: Company
3: Government
beneficiaryPostalCode
String

6
Optional
Beneficiary Postal Code
payoutMethod
String
4
Mandatory
Payout Method:
0: Over Booking,
1: Online Trans
2: SKN
3: RTGS
beneficiaryBankCode
String
4
Mandatory
Beneficiary Bank Code
amount
Array of
JSON Object
Variable
Mandatory
Amount Information
"amount": {...}
Value
String
12
Mandatory
Transaction amount, including thecents
Currency
String
3
Mandatory
Currency Code based on ISO
reservedDt
String
8
Optional
﻿
reservedTm
String
6
Optional
﻿
description
String
255
Optional
Description Transaction
deliveryName
String
100
Conditional
Name of the Beneficiary or Recipient.
Mandatory, For transactions above 100 million
deliveryId
String
20
Conditional
Recipient's Identification Number, such as ID Card, Passport, Driving
License
Mandatory, For transactions above 100 million 
beneficiaryPOE
String
50
Conditional
Beneficiary Place of Establishment
Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3 
beneficiaryDOE
String
8
Conditional
Beneficiary Date of Establishment
YYYYMMDD 
Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryCoNo
String
30
Conditional
Beneficiary Business License Number (NIB/TDB)
Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3 
beneficiaryAddress
String
255
Conditional
Beneficiary Company Address
Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryMerCategory
String
2
Conditional
﻿Payout Beneficiary Merchant Category - API SNAP﻿﻿
Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryAuthPhoneNumber
String
20
Conditional
Beneficiary Authorized Phone Number
For String only accept space and ‘+’ 
Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryCoMgmtName
String
100
Conditional
Beneficiary Company Management Name
Set Mandatory, For transactions, above 100 million and Beneficiary Type = 2 or 3
beneficiaryCoShName
String
255
Conditional
Beneficiary Company Shareholder Name
Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3 
﻿
Response Registration Payout (Disbursement) Parameter
Parameter
Type
Length
Required
Description
responseCode
String
7
Mandatory
Refer to General Response Code and Message - API SNAP﻿ List
responseMessage
String
150
Mandatory
Refer to General Response Code and Message - API SNAP﻿ List
partnerReferenceNo
String
40
Mandatory
Merchant Transaction Identifier
originalReferenceNo
String
40
Mandatory
Original Transaction Identifier on Service
Provider System
beneficiaryaccountNo
String
25
Mandatory
Beneficiary Account Number
beneficiaryName
String
100
Mandatory
Beneficiary Name
payoutMethod
String
4
Mandatory
Payout Method:
0: Over Booking
1: Online Trans
2: SKN
3: RTGS
beneficiaryBankCode
String
4
Mandatory
Beneficiary Bank Code - API SNAP﻿﻿
amount
Array of JSON
Object
Variable
Mandatory
Amount Information
"amount": {...}
value
String
12
Mandatory
Transaction Amount, If it’s IDR then value
includes 2 decimal digits.
e.g. IDR 10.000,- will be placed with
10000.00
currency
String
3
Mandatory
Currency Code based on ISO
﻿
Sample Parameter
Request Body
Sample Response
{
    "responseCode": "2000000",
    "responseMessage": "Successful",
    "partnerReferenceNo": "order1676975014155",
    "originalReferenceNo": "IONPAYTEST07202302211723331619",
    "beneficiaryaccountNo": "5345000060",
    "beneficiaryName": "NICEPAY",
    "payoutMethod": "1",
    "beneficiaryBankCode": "CENA",
    "amount": {
        "value": "12345678.00",
        "currency": "IDR"
    }
}
{
    "responseCode": "2000000",
    "responseMessage": "Successful",
    "partnerReferenceNo": "order1676975014155",
    "originalReferenceNo": "IONPAYTEST07202302211723331619",
    "beneficiaryaccountNo": "5345000060",
    "beneficiaryName": "NICEPAY",
    "payoutMethod": "1",
    "beneficiaryBankCode": "CENA",
    "amount": {
        "value": "12345678.00",
        "currency": "IDR"
    }
}
﻿
﻿

API Endpoint	/nicepay/api/v1.0/transfer/registration
HTTP Method	POST
Description	Create Transaction Payout or Disbursement
Content-type	application/json

Parameter	Type	Length	Required	Description	Remarks
Content-Type	String	127	Mandatory	Content type, value always application/json
Authorization	String	Variable	Mandatory	Bearer “accessToken”
X-TIMESTAMP	String	25	Mandatory	Using ISO 8601 as timestamp format. Transaction date time, in format YYYYMMDDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time). 2022-03-21T10:11:40+07:00.
X-SIGNATURE	String	Variable	Mandatory	Signature will be generated by Merchant. Panduan X-Signature - Symmetric
X-PARTNER-ID	String	20	Mandatory	Unique Partner ID, Partner ID = Client ID
X-EXTERNAL-ID	String	40	Mandatory	Unique messaging Reference ID generated by Merchant. Numeric String. Reference number that should be unique in every transaction.
CHANNEL-ID	String	5	Mandatory	Unique Channel Merchant Credential ID Number. Client ID + "01" = Channel ID "IONPAYTEST" + "01" = "IONPAYTEST01"	IONPAYTEST01

Parameter	Type	Length	Required	Description
partnerReferenceNo	String	40	Mandatory	Transaction ID from Merchant
merchantId	String	10	Mandatory	Merchant identifier that is unique per each Merchant
msId	String	20	Optional	Merchant Seller ID
beneficiaryAccountNo	String	25	Mandatory	Beneficiary Account Number
beneficiaryName	String	100	Mandatory	Beneficiary Name
beneficiaryPhone	String	20	Mandatory	Beneficiary Phone
beneficiaryCustomerResidence	String	2	Mandatory	Beneficiary Customer Residence: 1: Indonesia 2: Non Indonesia
beneficiaryCustomerType	String	2	Mandatory	Beneficiary Customer Type: 1: Personal 2: Company 3: Government
beneficiaryPostalCode	String	6	Optional	Beneficiary Postal Code
payoutMethod	String	4	Mandatory	Payout Method: 0: Over Booking, 1: Online Trans 2: SKN 3: RTGS
beneficiaryBankCode	String	4	Mandatory	Beneficiary Bank Code
amount	Array of JSON Object	Variable	Mandatory	Amount Information "amount": {...}
Value	String	12	Mandatory	Transaction amount, including thecents
Currency	String	3	Mandatory	Currency Code based on ISO
reservedDt	String	8	Optional
reservedTm	String	6	Optional
description	String	255	Optional	Description Transaction
deliveryName	String	100	Conditional	Name of the Beneficiary or Recipient. Mandatory, For transactions above 100 million
deliveryId	String	20	Conditional	Recipient's Identification Number, such as ID Card, Passport, Driving License Mandatory, For transactions above 100 million
beneficiaryPOE	String	50	Conditional	Beneficiary Place of Establishment Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryDOE	String	8	Conditional	Beneficiary Date of Establishment YYYYMMDD Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryCoNo	String	30	Conditional	Beneficiary Business License Number (NIB/TDB) Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryAddress	String	255	Conditional	Beneficiary Company Address Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryMerCategory	String	2	Conditional	Payout Beneficiary Merchant Category - API SNAP Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryAuthPhoneNumber	String	20	Conditional	Beneficiary Authorized Phone Number For String only accept space and ‘+’ Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3
beneficiaryCoMgmtName	String	100	Conditional	Beneficiary Company Management Name Set Mandatory, For transactions, above 100 million and Beneficiary Type = 2 or 3
beneficiaryCoShName	String	255	Conditional	Beneficiary Company Shareholder Name Set Mandatory, For transactions above 100 million and Beneficiary Type = 2 or 3

Parameter	Type	Length	Required	Description
responseCode	String	7	Mandatory	Refer to General Response Code and Message - API SNAP List
responseMessage	String	150	Mandatory	Refer to General Response Code and Message - API SNAP List
partnerReferenceNo	String	40	Mandatory	Merchant Transaction Identifier
originalReferenceNo	String	40	Mandatory	Original Transaction Identifier on Service Provider System
beneficiaryaccountNo	String	25	Mandatory	Beneficiary Account Number
beneficiaryName	String	100	Mandatory	Beneficiary Name
payoutMethod	String	4	Mandatory	Payout Method: 0: Over Booking 1: Online Trans 2: SKN 3: RTGS
beneficiaryBankCode	String	4	Mandatory	Beneficiary Bank Code - API SNAP
amount	Array of JSON Object	Variable	Mandatory	Amount Information "amount": {...}
value	String	12	Mandatory	Transaction Amount, If it’s IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00
currency	String	3	Mandatory	Currency Code based on ISO

Updated 24 Dec 2024

Did this page help you?

Payout API (Disbursement) - SNAP

Approve Transaction - API Payout (Disbursement) SNAP

Registration - API Payout (Disbursement) SNAP

About Registration - API Payout (Disbursement) SNAP

Registration - API Payout (Disbursement) SNAP

Request Registration Payout (Disbursement) Header Parameter

Request Registration Payout (Disbursement) Body Parameter

Response Registration Payout (Disbursement) Parameter

Sample Parameter

Welcome to NICEPAY DOCS