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
  • Sequence Diagram
  • Sample data

Was this helpful?

  1. Collections
  2. Transaction Status Management

Webhook

PreviousTransaction Status ManagementNextRefund Request Management

Last updated 4 months ago

Was this helpful?

,

Sequence Diagram

Event data

Parameter
Data Type
Description

transId

String

The ID of transaction.

type

String

TRANSACTION_STATUS

transDate

String

The time of transaction.

virtualAccountId

String

The ID of virtual account.

accountName

String

The account name.

amount

Number

The amount of collection transaction.

note

String

Note.

status

String

Transaction status

reconcileStatus

String

Transaction reconcile status, Include: UPLOADED: Documents for transaction were uploaded, waiting for verifying APPROVED: Transaction documents were verified REJECTED: Transaction documents were verified has been rejected. RECONCILED: Transaction was reconconciled SETTLED: Transaction was settled

payoutStatus

String

Transaction payout status, Include: READY: Transaction was settled and ready for Remitout (Appear when reconcileStatus change to "SETTLED"). PROCESSING: Remitout/Payout request is processing. REJECTED: Remitout/Payout request has been rejected. SUCCESS: Remitout/Payout request has success.

serviceInformation

Object

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

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_STATUS",
    "merchantCode": "UFLIYL",
    "transDate": "2023-10-10T07:06:37.436Z",
    "virtualAccountId": "NEO0001675",
    "accountName": "HIEP HOANG H",
    "amount": 20000,
    "note": "",
    "status": "SUCCESS",
    "reconcileStatus": "SETTLED",
    "payoutStatus": "READY",
    "serviceInformation": {
        "code": "GRAB",
        "desc": "TEST",
        "groupId": "DRIVER"
    }
}

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

HIEP HOANG H20000UFLIYLREADYSETTLEDGRABTESTDRIVERSUCCESS2023-10-10T07:06:37.436ZFT246560944209TRANSACTION_STATUSNEO0001675SUMTING
Configure the webhook