API Documentation
NeoX documents
NeoX documents
  • Introduction
  • NeoX App
    • E-Wallet
    • eKYC
    • Functionality
  • Payment Gateway
    • Payment Methods
    • Integrations
      • Hosted Checkout
        • Plugin/Extenstion
        • iOS SDK
        • Android SDK
        • React Native SDK
        • Web SDK
        • APIs
      • Direct API
        • Tokenization
      • Refund
        • APIs
        • IPN
    • Transaction Management
      • Query DR
      • Cancel
      • IPN
      • Error Codes
      • Refund on portal
    • Reconciliation
    • Settlement
  • Disbursement
    • Integration
      • Introduction
      • How To Register
      • Security Method
      • Generate token API
      • Get merchant profile API
      • Request disbursement API
      • Get disbursement transaction API
      • Get exchange rate API
      • Inquiry bank account API
      • Currency conversion API
      • Event Notification
      • Response Data Structure
      • Error codes
    • Disbursement Account
    • Disbursement request
    • Transaction Management
      • Query Request/Transaction
      • Webhook
      • Error Codes
    • Reconciliation
  • Collections
    • Integration
      • Introduction
      • How To Register
      • Security Method
      • API authenPlatform
      • API upload file
      • APIs for virtual accounts management
        • API create list of virtual accounts
        • API update KYC virtual account information
        • API update Virtual Account transaction data from merchant
        • API set active/inactive Virtual Account
        • API get list virtual accounts
        • API get detail virtual account
      • APIs for transactions management
        • API update transaction documents
        • API get list transactions
        • API get detail transaction
      • APIs for refund requests management
        • API create refund request
        • API get list refund requests
        • API get detail refund request
      • APIs for withdraw requests management
        • API get list withdraw banks
        • API create withdraw request
        • API get list withdraw requests
        • API get detail withdraw request
      • Event Notification
      • SFTP upload document file of collection transaction
      • Error Codes
    • Virtual Account Management
      • Virtual Account
      • Virtual Account Status
      • Webhook
    • Transaction Management
      • Webhook
    • Transaction Status Management
      • Webhook
    • Refund Request Management
      • Webhook
    • Withdraw Request Management
      • Webhook
    • Reconciliation
    • Settlement
  • Virtual Card
    • API authenPlatform
    • Error Codes
    • Virtual Card Policy Management
      • API Create Card Policy
      • API Get Detail Card Policy
      • API Get List Card Policies
      • API Set Active Card Policy
      • API Update Card Policy
    • Virtual Card Management
      • Virtual Card APIs
        • API Create Virtual Card
        • API Create List Virtual Cards
        • API Get List Virtual Cards
        • API Get Detail Virtual Card
        • API Get Virtual Card Sensitive Data
        • API Set Active Virtual Card
      • Webhook
      • Decrypting Card Data Algorithm
  • Merchant Portal
    • Onboarding
    • Payment Gateway
      • Reconciliation
      • Withdraw
    • Disbursement
      • Reports
    • Collections
      • Reports
      • Withdraw
Powered by GitBook
On this page
  • Configuration
  • Notification

Was this helpful?

  1. Collections
  2. Integration

Event Notification

PreviousAPI get detail withdraw requestNextSFTP upload document file of collection transaction

Last updated 3 months ago

Was this helpful?

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

  • 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:

No
Code
Group 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.

  1. Notification when transaction (reconcile) status changed

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

  1. Notification when refund request status changed

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

  1. Notification when withdraw request status changed

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

Webhook configuration
Create new configuration