# Payout Callback

## Method and URL

<mark style="color:green;">`POST`</mark> {[www.yourcompany.com}/payout\_webhook\_url](http://www.yourcompany.com}/payout_webhook_url)

## Request

**Header Request**&#x20;

<table><thead><tr><th>Parameter</th><th width="120">Data Type</th><th width="141">Requirement</th><th>Description</th></tr></thead><tbody><tr><td>X-API-Key</td><td>String</td><td>M</td><td>Callback API Key, an additional API Key used specifically for receiving callbacks</td></tr><tr><td>Content-Type</td><td>String</td><td>M</td><td>application/JSON</td></tr><tr><td>Accept</td><td>String</td><td>M</td><td>application/JSON</td></tr></tbody></table>

### **Request Body for Bulk Payout**

{% hint style="info" %}
For more details about each transaction, please retrieve a payout.
{% endhint %}

```json
{
  "event": "PAYOUT.DONE",
  "data": {
    "uuid": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0",
    "merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
    "payoutResults": {
      "totalPendingCount": 0,
      "totalPendingAmount": 0,
      "totalSuccessCount": 1,
      "totalSuccessAmount": 100000,
      "totalFailedCount": 0,
      "totalFailedAmount": 0,
      "totalCancelledCount": 0,
      "totalCancelledAmount": 0
    },
    "status": "DONE"
  }
}
```

### **Request Body for Single Payout**

```json
{
  "event": "PAYOUT.SUCCESS",
  "data": {
    "uuid": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0",
    "merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
    "payouts": {
      "referenceId": "TestReforzaPivot001",
      "amount": {
        "currency": "IDR",
        "value": "100000"
      },
      "status": "SUCCESS",
      "reason": null
    }
  }
}
```

**Detail Parameter Request**

<table><thead><tr><th>Parameter</th><th width="123">Data Type</th><th width="133">Requirement</th><th>Description</th></tr></thead><tbody><tr><td>event</td><td>String</td><td>M</td><td><p>Bulk Payout Event Names:<br></p><ol><li>PAYOUT.DONE</li><li>PAYOUT.PENDING</li><li>PAYOUT.DELAYED</li><li>PAYOUT.CANCELLED</li></ol><p><br></p><p>Single Payout Event Names:<br></p><ol><li>PAYOUT.SUCCESS</li><li>PAYOUT.FAILED</li><li>PAYOUT.DELAYED</li></ol></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/payout-callback.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.