# Payout Object

```json
{
  "created": "2024-05-13T08:21:45Z",
  "merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
  "payoutResults": {
    "totalFailedAmount": 0,
    "totalFailedCount": 0,
    "totalPendingAmount": 0,
    "totalPendingCount": 0,
    "totalSuccessAmount": 200000,
    "totalSuccessCount": 2,
    "totalCancelledCount": 0,
    "totalCancelledAmount": 0
  },
  "payouts": [
    {
      "amount": {
        "currency": "IDR",
        "value": "100000"
      },
      "channelCode": "BRI",
      "channelInformation": {
        "accountName": "Reforza Pivot",
        "accountNumber": "888801000157508"
      },
      "created": "2024-05-13T08:21:45Z",
      "inquiryId": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0",
      "description": "test Reforza Pivot",
      "referenceId": "999",
      "status": "SUCCESS",
      "reason": "",
      "updated": "2024-05-13T08:21:46Z"
    },
    {
      "amount": {
        "currency": "IDR",
        "value": "100000"
      },
      "created": "2024-05-13T08:21:45Z",
      "inquiryId": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0",
      "description": "test Reforza Pivot",
      "channelCode": "BRI",
      "channelInformation": {
        "accountName": "Reforza Pivot",
        "accountNumber": "888801000157508"
      },
      "referenceId": "1999",
      "status": "SUCCESS",
      "reason": "", 
      "updated": "2024-05-13T08:21:46Z"
    }
  ],
  "status": "DONE",
  "updated": "2024-05-13T08:21:46Z",
  "uuid": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0"
}
```

**Detail Payout Object** 

<table><thead><tr><th>Parameter</th><th width="110">Data Type</th><th width="131">Requirement</th><th>Description</th></tr></thead><tbody><tr><td>created</td><td>String</td><td>M</td><td>Timestamp when Payout request is made (using ISO 8601, Timezone UTC+0)</td></tr><tr><td>merchantId</td><td>String</td><td>M</td><td>Unique merchant ID given by Pivot</td></tr><tr><td>payoutsResults</td><td>Object</td><td>M</td><td><br></td></tr><tr><td><ul><li>totalFailedAmount</li></ul></td><td>Integer</td><td>M</td><td>Total Amount of all disbursement that has status Failed</td></tr><tr><td><ul><li>totalFailedCount</li></ul></td><td>Integer</td><td>M</td><td>The count of all disbursement that has status Failed</td></tr><tr><td><ul><li>totalPendingAmount</li></ul></td><td>Integer</td><td>M</td><td>Total Amount of all disbursement that has status Pending</td></tr><tr><td><ul><li>totalPendingCount</li></ul></td><td>Integer</td><td>M</td><td>The count of all disbursement that has status Pending</td></tr><tr><td><ul><li>totalSuccessAmount</li></ul></td><td>Integer</td><td>M</td><td>Total Amount of all disbursement that has status Success</td></tr><tr><td><ul><li>totalSuccessCount</li></ul></td><td>Integer</td><td>M</td><td>The count of all disbursement that has status Success</td></tr><tr><td>payouts</td><td>Array of Object</td><td>M</td><td></td></tr><tr><td><ul><li>amount</li></ul></td><td>Object</td><td>M</td><td></td></tr><tr><td><blockquote><ul><li>value</li></ul></blockquote></td><td>String</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>M</td><td><p>ISO 4217 </p><p><br>Example:</p><ul><li>Rupiah = IDR</li></ul></td></tr><tr><td><ul><li>channelCode</li></ul></td><td>String</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 data-mention href="/pages/VLaKKcjXG5xkE8l7BiiC">/pages/VLaKKcjXG5xkE8l7BiiC</a></p></td></tr><tr><td><ul><li>channelInformation</li></ul></td><td>Object</td><td>M</td><td></td></tr><tr><td><blockquote><ul><li>accountName</li></ul></blockquote></td><td>String</td><td>M</td><td>Account Name of payout destination</td></tr><tr><td><blockquote><ul><li>accountNumber</li></ul></blockquote></td><td>String</td><td>M</td><td>Account Number of payout destination</td></tr><tr><td><ul><li>created</li></ul></td><td>String</td><td>M</td><td>Timestamp when Payout transaction is made (using ISO 8601, Timezone UTC+0)</td></tr><tr><td><ul><li>inquiryId</li></ul></td><td>String</td><td></td><td>Inquiry ID returned by Pivot from inquiry bank account</td></tr><tr><td><ul><li>description</li></ul></td><td>String</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><tr><td><ul><li>referenceId</li></ul></td><td>String</td><td>M</td><td>Merchant provide unique identifier for payout request</td></tr><tr><td><ul><li>status</li></ul></td><td>String</td><td></td><td><p></p><p>Status of Payout transaction :</p><ol><li>APPROVED / REJECTED (current state always APPROVED in Open API)</li><li>PENDING</li><li>SUCCESS</li><li>FAILED</li></ol></td></tr><tr><td><ul><li>reason</li></ul></td><td>String</td><td></td><td><p>Detail reason for FAILED Payout transaction status</p><p><a data-mention href="/pages/MCplqtdZzT8iYQgrChgz#failure-reason">/pages/MCplqtdZzT8iYQgrChgz#failure-reason</a> </p></td></tr><tr><td><ul><li>updated</li></ul></td><td>String</td><td></td><td>Timestamp when Payout transaction status is updated (using ISO 8601, Timezone UTC+0)</td></tr><tr><td>status</td><td>String</td><td></td><td><p></p><p>Status of Payout request:</p><ol><li>IN PROGRESS</li><li>DONE </li><li>PENDING</li></ol></td></tr><tr><td>updated</td><td>String</td><td></td><td>Timestamp when Payout request status is updated (using ISO 8601, Timezone UTC+0)</td></tr><tr><td>uuid</td><td>String</td><td></td><td>Unique Bulk payout ID</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/payout-object.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.