> For the complete documentation index, see [llms.txt](https://docs.neox.vn/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.neox.vn/docs/disbursement/integration/request-disbursement-api.md).

# Request disbursement API

API

* This is the API to create the disbursement requests.
* Sequence Diagram

<figure><img src="https://1419689564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFdTKNedABvGBtqJRHWA0%2Fuploads%2FGfWl0jbwt1A1MqMmlvoj%2FPicture1_2.png?alt=media&amp;token=68ad447a-7cc7-4a4c-9811-31c49f1c7f99" alt=""><figcaption></figcaption></figure>

* API:
  * Path: /v2/dib/disbursementRequests
  * Method: POST
  * Request: Content-Type: application/json
* Request Parameter

<table><thead><tr><th width="144">Parameter</th><th width="178">Data Type</th><th width="126">Required</th><th>Description</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td>Y</td><td><p>UUID is generated by merchant. (Unique)</p><p>Exp:“90e7340b-5cbe-4ce7-886f-55181040af4f”</p></td></tr><tr><td>transactions</td><td><p>Array</p><p>[TransactionItem]</p></td><td>Y</td><td>List of disbursement transactions</td></tr></tbody></table>

* #### TransactionItem

<table><thead><tr><th width="224">Parameter</th><th width="117">Data Type</th><th width="102">Required</th><th>Description</th></tr></thead><tbody><tr><td>amount</td><td>Number</td><td>Y</td><td>The disbursement amount in VND (integer)</td></tr><tr><td>bankSwiftCode</td><td>String</td><td>Y</td><td>Swift Code of the receiving bank.</td></tr><tr><td>bankAccountNumber</td><td>String</td><td>Y</td><td>The bank account number of the receiver.</td></tr><tr><td>bankAccountName</td><td>String</td><td>Y</td><td>The bank account name of the receiver.</td></tr><tr><td>description</td><td>String</td><td>Y</td><td>The description of disbursement ([a-zA-Z0-9 _-])</td></tr><tr><td>bankBranchName</td><td>String</td><td>N</td><td>The branch name of the receiving bank.</td></tr><tr><td>requestTransId</td><td>String</td><td>Y</td><td>The Unique ID of disbursement transaction is provided by the merchant (when submitting the request).</td></tr><tr><td>srcAmount</td><td>Number</td><td>N</td><td>The amount - foreign currency (different from VND). Which will be deducted from pre-fund account</td></tr><tr><td>srcCurrency</td><td>String</td><td>N</td><td>The prefund account currency.</td></tr><tr><td>fxRate</td><td>Number</td><td>N</td><td>The exchange rate between the srcCurrency against the VND</td></tr></tbody></table>

* Response Data

<table><thead><tr><th width="185">Parameter</th><th width="119">Data Type</th><th>Description</th></tr></thead><tbody><tr><td>code</td><td>Number</td><td>System’s error code<br>refer to <a href="/docs/disbursement/integration/error-codes.md">table of error codes</a></td></tr><tr><td>message</td><td>String</td><td>Error description</td></tr><tr><td>data</td><td>Object</td><td>Data response, refer to <a href="/docs/disbursement/integration/response-data-structure.md">DisbursementRequestRespData</a></td></tr></tbody></table>
