> 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-notification.md).

# Collection Notification

Notifies the partner when funds arrive in a merchant collection account and provides the transaction and sender details needed for reconciliation.

**Notification delivery**

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

**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.

{% 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 events**

Pagsmile sends this notification when the collection transaction status changes to one of the following states:

* `1` — Reviewing
* `2` — Approved
* `7` — To be linked
* `11` — Rejected
* `15` — To be supplemented

Pagsmile also sends this notification when a refund reaches one of the following final states:

* `refunded` — The refund completed successfully.
* `refund failed` — The refund could not be completed.

**Notification body**

**Decrypted `biz_data` fields**

<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 associated with the notification.</td></tr><tr><td><code>collection_id</code></td><td>long</td><td>M</td><td>Pagsmile-assigned unique identifier of the collection transaction.</td></tr><tr><td><code>material_id</code></td><td>long</td><td>O</td><td>Pagsmile-assigned unique identifier of the material record.</td></tr><tr><td><code>collection_account_no</code></td><td>string</td><td>M</td><td>Account number of the collection account.</td></tr><tr><td><code>receive_amount</code></td><td>string</td><td>M</td><td>Amount credited in the receiving 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 credited to the recipient.</td></tr><tr><td><code>fee</code></td><td>string</td><td>O</td><td>Service fee charged for the transaction, expressed in the corresponding currency.</td></tr><tr><td><code>arrived_at</code></td><td>string</td><td>M</td><td>Date and time when the funds arrived.<br>Format: <code>yyyy-MM-dd HH:</code>​<code>mm:ss</code>.</td></tr><tr><td><code>collection_unique_no</code></td><td>string</td><td>M</td><td>Globally unique reference assigned to the collection transaction.</td></tr><tr><td><code>audit_status</code></td><td>integer</td><td>M</td><td>Current compliance or material review status of the record.<br>Supported values:<br><code>1</code> — Reviewing<br><code>2</code> — Approved<br><code>11</code> — Rejected<br><code>7</code> — To be linked<br><code>15</code> — To be supplemented</td></tr><tr><td><code>comments</code></td><td>string</td><td>O</td><td>Review comments or reason for rejection or failure, when provided.</td></tr><tr><td><code>sender.name</code></td><td>string</td><td>O</td><td>Name of the sender that originated the collection transaction.</td></tr><tr><td><code>sender.account_no</code></td><td>string</td><td>O</td><td>Account number from which the collection funds were sent.</td></tr><tr><td><code>sender.account_type</code></td><td>string</td><td>O</td><td>Type of the sender's bank account.</td></tr><tr><td><code>sender.descriptor</code></td><td>string</td><td>O</td><td>Statement descriptor or reference supplied for the sender.</td></tr><tr><td><code>sender.id_type</code></td><td>string</td><td>O</td><td>Type of identity document supplied for the sender.</td></tr><tr><td><code>sender.id_number</code></td><td>string</td><td>O</td><td>Identity document number supplied for the sender.</td></tr><tr><td><code>transaction_id</code></td><td>long</td><td>O</td><td>Pagsmile-assigned unique identifier of the transaction.</td></tr><tr><td><code>refund_amount</code></td><td>string</td><td>O</td><td>Amount returned in the original receiving currency. For a full refund, this value equals <code>receive_amount</code>. </td></tr><tr><td><code>refund_currency</code></td><td>string</td><td>O</td><td>Three-letter ISO 4217 code of the refund currency. This value is the same as <code>receive_currency</code>. </td></tr><tr><td><code>refund_status</code></td><td>string</td><td>O</td><td>Current refund status.<br>Supported values:<br><code>refunding</code> — The refund is being processed.<br><code>refunded</code> — The refund completed successfully.<br><code>refund failed</code> — The refund could not be completed.</td></tr><tr><td><code>refund_fee</code></td><td>string</td><td>O</td><td>Refund fee charged for the refund. </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: <code>yyyy-MM-dd HH:</code>​<code>mm:ss</code>.<br></td></tr></tbody></table>

**Plaintext `biz_data` example**

{% hint style="info" %}
This example includes mandatory fields and representative optional or conditional fields. Submit fields marked `C` only when the condition in the field description applies.
{% endhint %}

```json
{
  "merchant_id": 100398,
  "collection_id": 100001,
  "material_id": 100001,
  "collection_account_no": "1234567890",
  "receive_amount": "100.00",
  "receive_currency": "USD",
  "fee": "100.00",
  "arrived_at": "2026-07-20 10:30:00",
  "collection_unique_no": "COLLECTION_202607200001",
  "audit_status": 2,
  "comments": "Example reference",
  "sender": {
    "name": "Example Name",
    "account_no": "1234567890",
    "account_type": "CHECKING",
    "descriptor": "Example reference",
    "id_type": "passport",
    "id_number": "AB123456789"
  },
  "transaction_id": 100001,
  "refund_amount": "100.00",
  "refund_currency": "USD",
  "refund_status": "refunded",
  "refund_fee": "",
  "refunded_at": "2026-07-21 09:00:00"
}
```

{% hint style="info" %}
When Pagsmile returns a rejected collection before it is credited and the return reaches `refunded`, the collection changes to `Reversal` and this notification is sent. A refund performed after an approved collection has been credited does not change the collection from `Approved`; its result is reported through the refund fields.
{% endhint %}

**Acknowledgment**

Return any HTTP `2xx` status to acknowledge successful receipt. Any other status is treated as a delivery failure.

Failed deliveries are retried up to 7 times after approximately 10 seconds, 1 minute, 5 minutes, 30 minutes, 2 hours, 6 hours, and 24 hours. Process notifications idempotently because the same event may be delivered more than once.

**Related APIs**

* [Apply Collection Account](https://docs.pagsmile.com/remittance-api/business/collection/apply-collection-account)
* [Apply Collection Account Result Notification](https://docs.pagsmile.com/remittance-api/business/collection/apply-collection-account-result-notification)
* [Query Apply Collection Account Result](https://docs.pagsmile.com/remittance-api/business/collection/query-apply-collection-account-result)
* [Query Collection Account Detail](https://docs.pagsmile.com/remittance-api/business/collection/query-collection-account-detail)
* [Query Collection Accounts](https://docs.pagsmile.com/remittance-api/business/collection/query-collection-accounts)
* [Query Collections](https://docs.pagsmile.com/remittance-api/business/collection/query-collections)