# Refund Object

```json
{
  "id": "01990e74-5bc9-79a5-a651-400af0ad13ef",
  "clientReferenceId": "1755665477",
  "paymentSessionId": "44a14481-fa75-49a5-b17f-d03d8c5d52a6",
  "chargeId": "110eb890-d238-4212-aedc-533a8c77a53e",
  "capturedAmount": {
    "currency": "IDR",
    "value": "10000.00"
  },
  "isFullAmount": true,
  "amount": {
    "currency": "IDR",
    "value": "10000.00"
  },
  "status": "SUCCESS",
  "reason": "REQUESTED_BY_CUSTOMER",
  "description": "Customer didn't receive the Product",
  "destinationType": "CHANNEL",
  "method": "AUTO",
  "transferDestination": {
    "channelCode": "BCA",
    "channelInformation": {
      "accountNumber": "17677665415",
      "accountName": "Reforza Jordan Geotama"
    },
    "description": "Refund Pivot"
  },
  "metadata": {
    "notes": "Customer called support"
  },
  "createdAt": "2025-09-03T07:22:11Z",
  "updatedAt": "2025-09-03T07:22:13Z"
}
```

**Detail Refund Object** 

<table data-full-width="false"><thead><tr><th width="227.640625">Parameter</th><th width="132.4912109375">Data Type</th><th width="93.6103515625">Character Limit</th><th width="116.8662109375">Requirement</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>String</td><td>-</td><td>Auto Generated</td><td>Unique ID generated from Pivot as refund identifier</td></tr><tr><td>clientReferenceId</td><td>Alphanumeric</td><td>1-100</td><td>M</td><td>Unique ID from merchant to identify the refund</td></tr><tr><td>paymentSessionId</td><td>String</td><td>-</td><td>C</td><td>Payment Session ID merchant intend to perform refund on</td></tr><tr><td>chargeId</td><td>String</td><td>-</td><td>C</td><td>Singular Charge ID merchant intend to perform refund on</td></tr><tr><td>capturedAmount</td><td>Object</td><td>-</td><td>M</td><td>Total captured amount from Payment Session ID – amount available to be refunded</td></tr><tr><td><ul><li>currency</li></ul></td><td>String</td><td>1-3</td><td>M</td><td>Currency ISO 4217</td></tr><tr><td><ul><li>value</li></ul></td><td>String</td><td>1-18</td><td>M</td><td>Amount value</td></tr><tr><td>isFullAmount</td><td>Boolean</td><td>-</td><td>C</td><td><p>Indicate if the refund amount is the same with capturedAmount, possible values</p><ul><li>false (default) </li><li>true</li></ul></td></tr><tr><td>amount</td><td>Object</td><td>-</td><td>C</td><td>Required if <mark style="color:orange;"><code>isFullAmount</code></mark> = false</td></tr><tr><td><ul><li>currency</li></ul></td><td>String</td><td>1-3</td><td>M</td><td>Currency ISO 4217</td></tr><tr><td><ul><li>value</li></ul></td><td>String</td><td>1-18</td><td>M</td><td>Amount value</td></tr><tr><td>status</td><td>String</td><td>-</td><td>M</td><td><p>Status of Refund, possible values:</p><ul><li>PENDING</li><li>WAITING_BANK_TRANSFER</li><li>SUCCESS</li><li>FAILED</li><li>CANCELLED</li></ul></td></tr><tr><td>reason</td><td>String</td><td>-</td><td>M</td><td><p>Reason for user performing refund, possible values:</p><ul><li>SUSPECT_FRAUDULENT</li><li>DUPLICATE</li><li>REQUESTED_BY_CUSTOMER</li><li>CANCELLATION</li><li>OTHERS</li></ul></td></tr><tr><td>description</td><td>String</td><td>0-50</td><td>O</td><td>Information describing the refund for merchant internal notes</td></tr><tr><td>destinationType</td><td>String</td><td>-</td><td>C</td><td><p>Value is available after refund reached to final status, indicating the refund destination OR if <mark style="color:orange;"><code>status</code></mark> = <mark style="color:orange;"><code>WAITING_BANK_TRANSFER</code></mark> then value will always be ACCOUNT</p><p><br></p><p>Possible values</p><ul><li>CHANNEL → fund is credited back to the payment channel used on the transaction</li><li>ACCOUNT → fund is transferred to the submitted destination</li></ul></td></tr><tr><td>method</td><td>String</td><td>-</td><td>O</td><td><p>Refund method preferred by Merchant / customer, possible values:</p><ul><li>AUTO (default) →<br>Pivot will perform refund through Channel, if failed then fallback to Bank Transfer if available</li><li>TRANSFER_ONLY →<br>Refund will be performed through Bank Transfer only, Merchant is required to send the destination account</li></ul></td></tr><tr><td>transferDestination</td><td>Object</td><td>-</td><td>C</td><td>Required if <mark style="color:orange;"><code>preferredMethod</code></mark> = <mark style="color:orange;"><code>TRANSFER_ONLY</code></mark></td></tr><tr><td><ul><li>channelCode</li></ul></td><td>String</td><td>-</td><td>M</td><td><p>Channel code for payout destination such as Bank, E wallet or other channels</p><p></p><p>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>-</td><td>M</td><td></td></tr><tr><td><blockquote><ul><li>accountNumber</li></ul></blockquote></td><td>String</td><td>-</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>-</td><td>M</td><td>Account Name of payout destination</td></tr><tr><td><ul><li>description</li></ul></td><td>String</td><td>-</td><td>O</td><td><p>Information that will be seen by beneficiary account in statement</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>metadata</td><td>Object</td><td>-</td><td>O</td><td>Free object for merchant to store any extra information about the payment session</td></tr><tr><td>createdAt</td><td>String</td><td>-</td><td>M</td><td>Refund created time with format YYYY-MM-DDTHH:MM:SSZ</td></tr><tr><td>updatedAt</td><td>String</td><td>-</td><td>M</td><td>Refund latest updated time with format YYYY-MM-DDTHH:MM:SSZ</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/refunds/refund-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.