# Create a Payout

## Method and URL

<mark style="color:green;">`POST`</mark> \[<mark style="color:orange;">BASE\_URL</mark>]/v1/payouts

## Request

### **Request Body using Inquiry ID**

```json
{
  "payouts": [
    {
      "referenceId": "1999",
      "inquiryId": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0",
      "amount": {
        "value": "100000",
        "currency": "IDR"
      },
      "description": "test Reforza Pivot"
    }
  ]
}
```

**Detail Parameter Request**

<table><thead><tr><th>Parameter</th><th width="109">Data Type</th><th width="105.828125">Character limit</th><th width="128">Requirement</th><th>Description</th></tr></thead><tbody><tr><td>payouts</td><td>Array of Object</td><td>1-1000</td><td>M</td><td><br></td></tr><tr><td><ul><li>referenceId</li></ul></td><td>String</td><td>1-100</td><td>M</td><td>Merchant provide unique identifier for payout request</td></tr><tr><td><ul><li>inquiryId</li></ul></td><td>Uuid</td><td>-</td><td>M</td><td>Merchant provide Inquiry ID returned by Pivot from inquiry bank account</td></tr><tr><td><ul><li>amount</li></ul></td><td>Object</td><td>-</td><td>M</td><td></td></tr><tr><td><blockquote><ul><li>value</li></ul></blockquote></td><td>String</td><td>-</td><td>M</td><td><p>Amount </p><p>E.g: 10000</p></td></tr><tr><td><blockquote><ul><li>currency</li></ul></blockquote></td><td>String</td><td>1-10</td><td>M</td><td><p>ISO 4217 </p><p></p><p>Example:</p><ul><li>Rupiah = IDR</li></ul></td></tr><tr><td><ul><li>description</li></ul></td><td>String</td><td>1-20</td><td>O </td><td><p>Information that will be seen by beneficiary account in statement</p><p><br>Note:</p><ul><li>Maximum length each channel code is 20 characters</li><li>Support alphanumeric characters only</li></ul></td></tr></tbody></table>

### **Request Body using Channel Code & Channel Information**

```json
{
  "payouts": [
    {
      "referenceId": "999",
      "channelCode": "BRI",
      "channelInformation": {
        "accountNumber": "888801000157508",
        "accountName": "Reforza Pivot"
      },
      "amount": {
        "value": "100000",
        "currency": "IDR"
      },
      "description": "test Reforza Pivot"
    }
  ]
}
```

**Detail Parameter Request**

<table><thead><tr><th>Parameter</th><th width="121.85546875">Data Type</th><th width="109.484375">Character limit</th><th width="128">Requirement</th><th>Description</th></tr></thead><tbody><tr><td>payouts</td><td>Array of Object</td><td>1-1000</td><td>M</td><td><br></td></tr><tr><td><ul><li>referenceId</li></ul></td><td>String</td><td>1-100</td><td>M</td><td>Merchant provide unique identifier for payout request</td></tr><tr><td><ul><li>channelCode</li></ul></td><td>String</td><td>1-30</td><td>M</td><td><p>Channel code for payout destination such as Bank, E wallet or other channels</p><p><br>List of Channel code can be accessed <a href="/pages/VLaKKcjXG5xkE8l7BiiC">here</a></p></td></tr><tr><td><ul><li>channelInformation</li></ul></td><td>Object</td><td>-</td><td>M</td><td></td></tr><tr><td><blockquote><ul><li>accountNumber</li></ul></blockquote></td><td>String</td><td>1-60</td><td>M</td><td>Account Number of payout destination</td></tr><tr><td><blockquote><ul><li>accountName</li></ul></blockquote></td><td>String</td><td>1-60</td><td>M</td><td>Account Name of payout destination</td></tr><tr><td><ul><li>amount</li></ul></td><td>Object</td><td>-</td><td>M</td><td></td></tr><tr><td><blockquote><ul><li>value</li></ul></blockquote></td><td>String</td><td>-</td><td>M</td><td><p>Amount </p><p>E.g: 10000</p></td></tr><tr><td><blockquote><ul><li>currency</li></ul></blockquote></td><td>String</td><td>1-10</td><td>M</td><td><p>ISO 4217 </p><p></p><p>Example:</p><ul><li>Rupiah = IDR</li></ul></td></tr><tr><td><ul><li>description</li></ul></td><td>String</td><td>1-20</td><td>O </td><td><p>Information that will be seen by beneficiary account in statement</p><p></p><p>Note:</p><ul><li>Maximum length each channel code is 20 characters</li><li>Support alphanumeric characters only</li></ul></td></tr></tbody></table>

## Response

**Response Body**

```json
{
  "code": "00",
  "message": "Success",
  "data": {
    "created": "2024-05-13T08:21:44.967496435Z",
    "merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
    "payouts": [
      {
        "amount": {
          "currency": "IDR",
          "value": "100000"
        },
        "inquiryId": "",
        "channelCode": "BRI",
        "channelInformation": {
          "accountName": "Reforza Pivot",
          "accountNumber": "888801000157508"
        },
        "description": "test Reforza Pivot",
        "referenceId": "999"
      }
    ],
    "status": "IN_PROGRESS",
    "updated": "2024-05-13T08:21:44.967496538Z",
    "uuid": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0"
  }
}
```

**Detail Parameter Response**

<table><thead><tr><th>Parameter</th><th width="113">Data Type</th><th width="132">Requirement</th><th>Description</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>M</td><td>Response code</td></tr><tr><td>message</td><td>String</td><td>M</td><td>Response description</td></tr><tr><td>data</td><td>Object</td><td>M</td><td>Payout Object. Refers to <a data-mention href="/pages/b3eEJfoPKqX4cqj2bHiG">/pages/b3eEJfoPKqX4cqj2bHiG</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/create-a-payout.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.