API Documentation
NeoX documents v.2
NeoX documents v.2
  • 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
      • 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
  • Sequence Diagram
  • Sample data

Was this helpful?

  1. Collections
  2. Transaction Management

Webhook

PreviousTransaction ManagementNextTransaction Status Management

Was this helpful?

Sequence Diagram

Event data

Parameter
Data Type
Description

transId

String

The ID of transaction.

type

String

TRANSACTION

merchantCode

String

Merchant Code

transDate

String

The time of transaction.

virtualAccountRequestId

String

The ID of seller/business is provided by merchant.

virtualAccountId

String

The ID of virtual account.

accountName

String

The account name.

amount

Number

The amount of collection transaction.

note

String

Note.

serviceInformation

Object

Extra data includes "code", "groupId", "desc"

debitorInformation

Object

Debitor info object include: "bankName": Debit fom bank name "bankAccountNumber": Debitor bank account "bankAccountName": Debitor bank account name "bankRemark": Transaction remark received from debitor's bank.

secureHash

String

(Base64)

Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (configured on Merchant Portal, in the Collection service menu)

Sample data

{
    "transId": "FT246560944209",
    "type": "TRANSACTION",
    "merchantCode": "UFLIYL",
    "transDate": "2023-10-10T07:06:37.436Z",
    "virtualAccountRequestId": "54f35db9-553b-4078-8271-7863162903c0",
    "virtualAccountId": "NEO0001675",
    "accountName": "HIEP HOANG",
    "amount": 20000,
    "note": "NEO1696918592059",
    "serviceInformation": {
        "code": "GRAB",
        "desc": "testtttt",
        "groupId": "DRIVER"
    },
    "debitorInformation": {
        "bankName": "Simulator connector",
        "bankAccountNumber": "09874732621",
        "bankAccountName": "Simulator account",
        "bankRemark": "691079-CTY TNHH TMDT HIEP HOANG payment for order 123456 NEO188879_NEO0001675"
    },
    "secureHash": "dXNENfQTIa9KgImBXJu2qFRprAcPhYydbBY8AlnmvgY="
}

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

HIEP HOANG20000Simulator account09874732621Simulator connector691079-CTY TNHH TMDT HIEP HOANG payment for order 123456 NEO188879_NEO0001675UFLIYLNEO1696918592059GRABtestttttDRIVER2023-10-10T07:06:37.436ZFT246560944209TRANSACTIONNEO000167554f35db9-553b-4078-8271-7863162903c0SUMTING
Configure the webhook