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. Disbursement
  2. Integration

Request disbursement API

API

PreviousGet merchant profile APINextGet disbursement transaction API

Last updated 10 months ago

Was this helpful?

  • This is the API to create the disbursement requests.

  • Sequence Diagram

  • API:

    • Path: /v2/dib/disbursementRequests

    • Method: POST

    • Request: Content-Type: application/json

  • Request Parameter

Parameter
Data Type
Required
Description

requestId

String

Y

UUID is generated by merchant. (Unique)

Exp:“90e7340b-5cbe-4ce7-886f-55181040af4f”

transactions

Array

[TransactionItem]

Y

List of disbursement transactions

  • TransactionItem

Parameter
Data Type
Required
Description

amount

Number

Y

The disbursement amount in VND (integer)

bankSwiftCode

String

Y

Swift Code of the receiving bank.

bankAccountNumber

String

Y

The bank account number of the receiver.

bankAccountName

String

Y

The bank account name of the receiver.

description

String

Y

The description of disbursement ([a-zA-Z0-9 _-])

bankBranchName

String

N

The branch name of the receiving bank.

requestTransId

String

Y

The Unique ID of disbursement transaction is provided by the merchant (when submitting the request).

srcAmount

Number

N

The amount - foreign currency (different from VND). Which will be deducted from pre-fund account

srcCurrency

String

N

The prefund account currency.

fxRate

Number

N

The exchange rate between the srcCurrency against the VND

  • Response Data

Parameter
Data Type
Description

code

Number

message

String

Error description

data

Object

System’s error code refer to

Data response, refer to

table of error codes
DisbursementRequestRespData