Event Notification

Usage

• This is the API that the Platform should create to receive notifications of events that occur from NeoX.

• Sequence Diagram

  • Notifies about balance amount

  

  • Notifies about disbursement transaction

  

API

• Path: the URL(https://<<yourdomain.com/api/notifi>>) Webhook is created and configured by Platform on Merchant Portal, in the “Disbursement service” menu

• Method: POST

• Request: Body

Notification type

Notifies about balance amount

Parameter	Data Type	Description
service	String	“DISBURSEMENT”
type	String	“BALANCE”
value	Number	The current amount.
time	String	The time of the event.
secureHash	String (Base64)	Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (configured on Merchant Portal, in the “Disbursement service” menu)

Notifies about disbursement transaction happened

Parameter	Data Type	Description
service	String	“DISBURSEMENT”
type	String	“TRANSACTION”
data	Object	Data response, refer to DisbursementTransactionItem
time	String	The time of the event.
secureHash	String (Base64)	Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (configured on Merchant Portal, in the “Disbursement service” menu)

Notifies about currency exchanged

Parameter	Data Type	Description
service	String	“DISBURSEMENT”
type	String	“EXCHANGE”
data	Object	Data response, refer to ExchangeTransactionItem
time	String	The time of the event.
secureHash	String (Base64)	Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (configured on Merchant Portal, in the “Disbursement service” menu)