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
  • Merchant Portal
    • Onboarding
    • Payment Gateway
      • Reconciliation
      • Withdraw
    • Disbursement
      • Reports
    • Collections
      • Reports
      • Withdraw
Powered by GitBook
On this page
  • Configure the webhook to receive the IPN
  • Sequence Diagram
  • Response Data
  • Sample data

Was this helpful?

  1. Disbursement
  2. Transaction Management

Webhook

PreviousQuery Request/TransactionNextError Codes

Last updated 1 year ago

Was this helpful?

Configure the webhook to receive the IPN

  • Enable Use APIs

  • Fill in the URL to receive notifications for changes in credit limit

  • Fill in the Secret Key

Sequence Diagram

Response Data

Parameter
Data Type
Description

service

String

“DISBURSEMENT”

type

String

“TRANSACTION”

data

Object

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)

Sample data

{
  "service": "DISBURSEMENT",
  "type": "TRANSACTION",
  "data": {
    "requestId": "826ae17b-8c96-42aa-aca2-196b94e21772",
    "amount": 200000,
    "fee": 0,
    "requestTransId": "transid-e360530e-5176-4830-aaf2-e744627ea931",
    "transId": "CH-101020230NLUW19L",
    "status": "SUCCESS",
    "receiver": "NGUYEN VAN A",
    "bankAccountNumber": "4396828945",
    "failedReason": "Successful transaction",
    "srcAmount": 200000,
    "srcCurrency": "VND",
    "fxRate": 1,
    "code": 1
  },
  "time": "2023-10-10T07:15:12.042Z",
  "secureHash": "ELsrE1knfvTD8JxPmyChO8VayUUzry6ptZJ0I+jPsac="
}

With the secretKey "123", the string used to create secureHash will be:

20000043968289451Successful transaction01NGUYEN VAN A826ae17b-8c96-42aa-aca2-196b94e21772transid-e360530e-5176-4830-aaf2-e744627ea931200000VNDSUCCESSCH-101020230NLUW19LDISBURSEMENT2023-10-10T07:15:12.042ZTRANSACTION123

Data response, refer to

DisbursementTransactionItem