Request disbursement API

API

• 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
extData	Object	N	{ <Field1>, <Field2> ... } Require to register field name. extData will be shown in webhook and reconciliation report.

• Response Data

Parameter	Data Type	Description
code	Number	System’s error code refer to table of error codes
message	String	Error description
data	Object	Data response, refer to DisbursementRequestRespData