Event Notification

This is the API that should be created by platform to receive notifications from NeoX including created virtual accounts and transaction events.

Configuration

Config to receive notification about created accounts and successful transaction events.

Parameters description

  • URL: Webhook URL

  • Secret key: Use to verify data from NeoX

  • Authorization type: No Auth or Basic Auth

  • Type: ACCOUNT | TRANSACTION

  • Code: Optional, mapping to "serviceInfomation.code" in creating a virtual account request. If you fill in the "Code", the URL will be received transaction notifications of that virtual accounts having the same "Code".

  • Group id: Optional, mapping to "serviceInfomation.groupId" in creating a virtual account request. If you fill in the "Group id", the URL will be received transaction notifications of that virtual accounts having the same "Group id".

"Code" and "Group id" are $and conditions

For example, merchant create a virtual account with "serviceInfomation.code" = "001" and "serviceInfomation.groupId" = "GR01". There are four configuration ways to receive the transaction notifications:

NoCodeGroup id
1

001

GR01

2

001

empty

3

empty

GR01

4

empty

empty

Notification

NeoX will send a POST request to configured URL whenever there is an event happen.

  1. Notification of collection transaction happened

View event object data of type "TRANSACTION". Click here.

  1. Notification of virtual accounts created

View event object data of type "ACCOUNT". Click here.

PreviousAPI update Virtual Account transaction data from merchantNextSFTP upload document file of collection transaction

Last updated