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

Was this helpful?

  1. Collections
  2. Refund Request Management

Webhook

Event data

Parameter
Data Type
Description

merchantCode

String

Merchant Code

requestId

String

The requestId when creating refund request.

type

String

Webhook type: Default value "REFUND"

collectionTransId

String

Collection's TransactionId of current refund request

approvalStatus

String

Refund request status, Include: PENDING: Refund request is waiting for approval. APPROVED: Refund request was approved. REJECTED: Refund request was rejected.

status

String

Refund transaction status, Include: SUCCESS: Refund transaction was successful FAILED: Refund transaction was failed

bankSwiftCode

String

Refund/Remitout bank swift code.

bankAccountNumber

String

Refund to bank acount number

bankAccountName

String

Refund to bank acount name.

amount

Number

Amount of refund request in VND

note

String

Note for refund request

failedReason

String

Return failed reason from banking system if refund transaction was failed

secureHash

String

(Base64)

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

Sample data

{
  "merchantCode": "FVPLLB",
  "requestId": "REFUND-629570097321",
  "collectionTransId": "FT193341033222",
  "amount": 123456,
  "bankSwiftCode": "MCOBVNVX",
  "bankAccountNumber": "9698890000",
  "bankAccountName": "SUMTING WONG",
  "status": "PROCESSING",
  "approvalStatus": "PENDING",
  "createdAt": "2025-05-26T02:43:45.689Z",
  "note": "Test create refund request",
  "secureHash": "vNWPuLtvgzXpB5GKqQPyZEpM+Dbohf2wGjN2/8ho6e4="
}

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

123456PENDINGSUMTING WONG9698890000MCOBVNVXFT193341033222FVPLLBTest create refund requestREFUND-629570097321PROCESSINGREFUNDSumtingWong@123
PreviousRefund Request ManagementNextWithdraw Request Management

Last updated 5 days ago

Was this helpful?