> For the complete documentation index, see [llms.txt](https://docs.pagsmile.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pagsmile.com/reference/remittance-api/business/collection/collection-refund-notification.md).

# Collection Refund Notification

Notifies the partner of a collection refund and its current status.

### Notification delivery

Pagsmile sends an HTTP POST request to your configured webhook URL.

Content-Type: application/json; charset=UTF-8

The notification uses the [Webhook Common envelope](https://docs.pagsmile.com/remittance-api/common/webhook-common). The fields below describe the decrypted `biz_data` object.

Webhook notify\_type: 201.

{% hint style="info" %}
**Requirement:** `M` = Mandatory, `O` = Optional, and `C` = Conditional. A conditional field is mandatory only when the condition stated in its description applies.
{% endhint %}

### Notification body

The following fields describe the decrypted biz\_data object.

<table><thead><tr><th width="205.2109375">Field</th><th width="105.6640625">Type</th><th width="109.33203125">Requirement</th><th>Description</th></tr></thead><tbody><tr><td><code>merchant_id</code></td><td>long</td><td>M</td><td>Pagsmile-assigned unique identifier of the merchant.</td></tr><tr><td><code>collection_id</code></td><td>long</td><td>M</td><td>Pagsmile-assigned unique identifier of the original collection.</td></tr><tr><td><code>receive_amount</code></td><td>string</td><td>M</td><td>Original amount received for the collection, expressed in receive_currency.</td></tr><tr><td><code>receive_currency</code></td><td>string</td><td>M</td><td>Three-letter ISO 4217 code of the currency in which the original collection amount was received.</td></tr><tr><td><code>refund_status</code></td><td>int</td><td>M</td><td>Current refund status.<br>1 — Refunding.<br>2 — Refunded.<br>3 — Refund Failed.</td></tr><tr><td><code>refund_amount</code></td><td>string</td><td>M</td><td>Amount of the collection refund, expressed in refund_currency.</td></tr><tr><td><code>refund_currency</code></td><td>string</td><td>M</td><td>Three-letter ISO 4217 code of the refund currency. This is the original collection currency.</td></tr><tr><td><code>refund_fee</code></td><td>string</td><td>O</td><td>Fee charged for the collection refund, expressed in refund_currency.</td></tr><tr><td><code>refund_order_no</code></td><td>string</td><td>O</td><td>Order number of the collection refund, when available.</td></tr><tr><td><code>refund_transaction_id</code></td><td>Long</td><td>O</td><td>Pagsmile-assigned unique identifier of the collection refund transaction.</td></tr><tr><td><code>refund_reversal_order_no</code></td><td>string</td><td>O</td><td>Order number of the collection refund reversal, when available.</td></tr><tr><td><code>refund_reversal_transaction_id</code></td><td>long</td><td>O</td><td>Pagsmile-assigned unique identifier of the refund reversal transaction.<br>Returned when refund_status is 3 (Refund Failed).</td></tr><tr><td><code>refunded_at</code></td><td>string</td><td>O</td><td>Date and time when the refund completed successfully.<br>Format: yyyy-MM-dd HH:mm:ss.<br>Returned when refund_status is 2 (Refunded).</td></tr><tr><td><code>refund_created_at</code></td><td>string</td><td>M</td><td>Date and time when the refund request was created.<br>Format: yyyy-MM-dd HH:mm:ss.</td></tr></tbody></table>

### Plaintext biz\_data example

```json
{
  "merchant_id": 100398,
  "collection_id": 100001,
  "receive_amount": "100.00",
  "receive_currency": "USD",
  "refund_status": 2,
  "refund_amount": "100.00",
  "refund_currency": "USD",
  "refund_fee": "0.00",
  "refund_order_no": "REFUND_202610270001",
  "refund_transaction_id": 100002,
  "refunded_at": "2026-10-26 10:35:00",
  "refund_created_at": "2026-10-26 10:30:00"
}
```

### Refund failed example

```json
{
  "merchant_id": 100398,
  "collection_id": 100001,
  "receive_amount": "100.00",
  "receive_currency": "USD",
  "refund_status": 3,
  "refund_amount": "100.00",
  "refund_currency": "USD",
  "refund_fee": "0.00",
  "refund_order_no": "REFUND_202610270001",
  "refund_transaction_id": 100002,
  "refund_reversal_order_no": "REVERSAL_202610270001",
  "refund_reversal_transaction_id": 100003,
  "refund_created_at": "2026-10-26 10:30:00"
}
```

### Acknowledgement

Return any HTTP 2xx status code after the notification is safely recorded. Process repeated notifications idempotently using the webhook request\_id. For delivery, retries, and signature handling, refer to Webhook Common.
