Notification - API Payout (Disbursement) SNAP

9min

About Notification - API Payout (Disbursement) SNAP
﻿
This API with SNAP standards uses to send the notification from Payout or Disbursement proses result.
﻿
X-SIGNATURE Guidance Validation
﻿
The following is guidance to proceed X-SIGNATURE validation on Request Header Notify:
SHA256withRSA (Public_Key, stringToSign) stringToSign = client_ID + “|” + X-TIMESTAMP
The following is the example of X-SIGNATURE result from the above guidance validation"
mYyscWBs00bm0TJQ/xY7Uu1Goh8qXJyYSlo88rFrhQ+mlyQkMtq
NKMlZDpS+
﻿
Merchant Notification - API Payout (Disbursement) SNAP
﻿
API Endpoint
[merchant-domain]/api/v1.0/transfer/notify
HTTP Method
POST
Content-type
application/json
Description
Transaction Result Notification (when success)
If your system use firewall, add allow policy for NICEPAY IP
103.20.51.0/24
103.117.8.0/24
﻿
Request Notification Header Parameter
Parameter
Tipe
Kebutuhan
Deskripsi
Content-Type
String
Mandatory
Application / JSON
X-TIMESTAMP
String
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-CLIENT-KEY
String
Mandatory
Unique Partner ID, Partner ID = Client ID
X-SIGNATURE
String
Mandatory
Request message signature
(85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5)
﻿
Request Notification Body Parameter
Parameter
Type
Length
Required
Description
originalPartnerReferenc
eNo
String
40
Mandatory
Original transaction identifier on consumer
system
originalReferenceNo
String
40
Mandatory
Original transaction identifier on service
provider system
latestTransactionStatus
String
2
Mandatory
Category code for the status of the
transaction. Example :
00- Success
03- Pending
09- Failed
transactionStatusDesc
Object
50
Optional
Description status transaction
beneficiaryBankCode
String
4
Mandatory
Beneficiary Bank Code - API SNAP﻿﻿
beneficiaryAccountNo
String
25
Mandatory
Beneficiary Account Number
beneficiaryName
String
100
Mandatory
Beneficiary Name
amount
Object
Variable
Mandatory
Amount of transaction
value
String
12
Mandatory
Value
currency
String
3
Mandatory
Currency
transactionDateTime
String
25
Optional
Transaction Date Using ISO-8601 Format
YYYY-MM-DDTHH:MM:SS
﻿
Response Notification Header Parameter
Parameter
Type
Required
Description
Content-Type
String
Mandatory
Application / JSON
X-TIMESTAMP
String
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.
﻿
Response Notification Body Parameter
Parameter
Type
Length
Required
Description
﻿
﻿
responseCode
String
7
Mandatory
﻿General Response Code and Message - API SNAP﻿﻿
﻿
﻿
responseMessage
String
150
Mandatory
Response Message
﻿
﻿
﻿
Sample Post For Notification
Sample Request Notification
Sample Response Notification
//HEADER SECTION
Content-type: application/json
X-TIMESTAMP: 2023-11-23T07:44:11+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-CLIENT-KEY: 82150823919040624621823174737537

{
  "originalPartnerReferenceNo": "2020102900000000000001",
  "originalReferenceNo": "TNICEPO07105202210141451109841",
  "latestTransactionStatus": "00",
  "transactionStatusDesc": "success",
  "beneficiaryBankCode": "BBBA",
  "beneficiaryAccountNo": "888801000003301",
  "beneficiaryName": "Yories Yolanda",
  "amount": {
    "value": "12345678.00",
    "currency": "IDR"
  },
  "transactionDateTime": "2019-07-03T12:08:56-07:00"
}
//HEADER SECTION
Content-type: application/json
X-TIMESTAMP: 2023-11-23T07:44:11+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-CLIENT-KEY: 82150823919040624621823174737537

{
  "originalPartnerReferenceNo": "2020102900000000000001",
  "originalReferenceNo": "TNICEPO07105202210141451109841",
  "latestTransactionStatus": "00",
  "transactionStatusDesc": "success",
  "beneficiaryBankCode": "BBBA",
  "beneficiaryAccountNo": "888801000003301",
  "beneficiaryName": "Yories Yolanda",
  "amount": {
    "value": "12345678.00",
    "currency": "IDR"
  },
  "transactionDateTime": "2019-07-03T12:08:56-07:00"
}
﻿
﻿

API Endpoint	[merchant-domain]/api/v1.0/transfer/notify
HTTP Method	POST
Content-type	application/json
Description	Transaction Result Notification (when success) If your system use firewall, add allow policy for NICEPAY IP 103.20.51.0/24 103.117.8.0/24

Parameter	Tipe	Kebutuhan	Deskripsi
Content-Type	String	Mandatory	Application / JSON
X-TIMESTAMP	String	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-CLIENT-KEY	String	Mandatory	Unique Partner ID, Partner ID = Client ID
X-SIGNATURE	String	Mandatory	Request message signature (85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5)

Parameter	Type	Length	Required	Description
originalPartnerReferenc eNo	String	40	Mandatory	Original transaction identifier on consumer system
originalReferenceNo	String	40	Mandatory	Original transaction identifier on service provider system
latestTransactionStatus	String	2	Mandatory	Category code for the status of the transaction. Example : 00- Success 03- Pending 09- Failed
transactionStatusDesc	Object	50	Optional	Description status transaction
beneficiaryBankCode	String	4	Mandatory	Beneficiary Bank Code - API SNAP
beneficiaryAccountNo	String	25	Mandatory	Beneficiary Account Number
beneficiaryName	String	100	Mandatory	Beneficiary Name
amount	Object	Variable	Mandatory	Amount of transaction
value	String	12	Mandatory	Value
currency	String	3	Mandatory	Currency
transactionDateTime	String	25	Optional	Transaction Date Using ISO-8601 Format YYYY-MM-DDTHH:MM:SS

Parameter	Type	Required	Description
Content-Type	String	Mandatory	Application / JSON
X-TIMESTAMP	String	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.

Parameter	Type	Length	Required	Description
responseCode	String	7	Mandatory	General Response Code and Message - API SNAP
responseMessage	String	150	Mandatory	Response Message

Updated 31 Jul 2024

Did this page help you?

Balance Inquiry - API Payout (Disbursement) SNAP

Advance API - SNAP

Notification - API Payout (Disbursement) SNAP

About Notification - API Payout (Disbursement) SNAP

X-SIGNATURE Guidance Validation

Merchant Notification - API Payout (Disbursement) SNAP

Request Notification Header Parameter

Request Notification Body Parameter

Response Notification Header Parameter

Response Notification Body Parameter

Sample Post For Notification

Welcome to NICEPAY DOCS