> For the complete documentation index, see [llms.txt](https://pivot-payment.gitbook.io/pivot-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-local/retrieve-a-payout.md).

# Retrieve a Payout

Retrieve details of a Payout Request by specifying the payout ID.

## Method and URL

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

<mark style="color:orange;">`uuid`</mark> from the response body whenever you create a Payout

## **Query Params**

| Key     | Value                                                                                                     |
| ------- | --------------------------------------------------------------------------------------------------------- |
| page    | Page to be shown                                                                                          |
| perPage | <p>Total record to be shown per page</p><p></p><p>Maximum 100 records per page, default is 20 records</p> |

## Response

**Response Body**

```json
{
  "code": "00",
  "message": "Success",
  "data": {
    "created": "2024-05-13T08:21:45Z",
    "merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
    "payoutResults": {
      "totalFailedAmount": 0,
      "totalFailedCount": 0,
      "totalPendingAmount": 0,
      "totalPendingCount": 0,
      "totalSuccessAmount": 100000,
      "totalSuccessCount": 1,
      "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"
      }
    ],
    "status": "DONE",
    "updated": "2024-05-13T08:21:46Z",
    "uuid": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0"
  },
  "pagination": {
    "page": 1,
    "perPage": 20,
    "totalItems": 1,
    "totalPages": 1
  }
}
```

**Detail Parameter Response**

<table><thead><tr><th>Parameter</th><th width="110">Data Type</th><th width="128">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><tr><td>pagination</td><td>Object</td><td>M</td><td><a data-mention href="/pages/26jTesCmqwwSXkJaVf9X">/pages/26jTesCmqwwSXkJaVf9X</a></td></tr></tbody></table>