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. Withdraw Request Management

Webhook

Event data

Parameter
Data Type
Description

withdrawRequestId

String

Withdraw/Remitout request id

type

String

Webhook type: Default value "WITHDRAW"

approvalStatus

String

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

status

String

Withdraw/Remitout transaction status, Include: SUCCESS: Withdraw transaction was successful. FAILED: Withdraw request was failed.

bankSwiftCode

String

Withdraw/Remitout bank swift code.

bankAccountNumber

String

Withdraw/Remitout bank acount number.

bankAccountName

String

Withdraw/Remitout bank acount name.

amount

Number

Amount of withdraw/remitout request in VND

currency

Number

(Optional) Remitout request currency

remitedAmount

Number

(Optional) Amount of remitout request in currency

collectionTransactions

Array Object

(Optional) List of Collection transactions envolved to withdraw/remitout request. Object data:

note

String

Note for withdraw/remitout request

failedReason

String

Return failed reason from banking system if withdraw 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

{
  "requestId": "CASHOUT-443826686072",
  "type": "WITHDRAW",
  "status": "PENDING",
  "bankSwiftCode": "SCBLSG22XXX",
  "bankAccountNumber": "0107201111",
  "bankAccountName": "STANDARD CHARTERED BANK TEST ACCOUNT",
  "amount": 150000,
  "currency": "USD",
  "destinationAmount": 5.91,
  "fxRate": 25380.71,
  "collectionTransactions": [{
    "virtualAccountId": "96988900021615",
    "reconcileCode": "TH-13122024-SUMTIN",
    "transId": "FT24323L4AAA",
    "amount": 100000,
    "transDate": "2024-12-12T02:47:05.409Z"
  }, {
    "virtualAccountId": "96988900021615",
    "reconcileCode": "TH-13122024-SUMTIN",
    "transId": "FT24323L4ZZZ",
    "amount": 50000,
    "transDate": "2024-12-09T02:47:05.409Z"
  }],
  "secureHash": "I/M2Y6rsb1x+hImL1fEBr4WHQpk6OJ8jUN4X2F3OM4Q="
}

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

150000STANDARD CHARTERED BANK TEST ACCOUNT0107201111SCBLSG22XXX100000TH-13122024-SUMTIN2024-12-12T02:47:05.409ZFT24323L4AAA9698890002161550000TH-13122024-SUMTIN2024-12-09T02:47:05.409ZFT24323L4ZZZ96988900021615USD5.9125380.71CASHOUT-443826686072PENDINGWITHDRAWSUMTING
PreviousWithdraw Request ManagementNextReconciliation

Last updated 18 days ago

Was this helpful?

{
  "virtualAccountId": String,
  "reconcileCode": String,
  "transId": String,
  "amount": Number,
  "transDate": String
}