> 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/payout/payout-reconciliation.md).

# Payout Reconciliation

The Payout Reconciliation API allows merchants to retrieve generated daily or monthly statements for reconciling Payout account activity. A statement may include payout transactions and applicable account activities such as deposits, withdrawals, deductions, and refunds.

The API returns a statement download URL and an extraction password. The downloaded file is a password-protected ZIP archive containing the statement in CSV format.

{% hint style="warning" %}
This API is available only in the production environment and cannot be used in the sandbox environment. Send requests using your production `AppId` and credentials.
{% endhint %}

<mark style="color:green;">`POST`</mark> `https://api.transfersmile.com/api/statement`

### Headers

<table><thead><tr><th width="180">Name</th><th width="110">Type</th><th width="120">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>Content-Type</code></td><td>string</td><td>Required</td><td>Request content type. Use <code>application/json; charset=UTF-8</code>.</td></tr><tr><td><code>AppId</code></td><td>string</td><td>Required</td><td>Merchant application ID obtained from the Pagsmile dashboard.</td></tr><tr><td><code>Authorization</code></td><td>string</td><td>Required</td><td>Lowercase SHA-256 signature generated from the sorted Request Body parameters and the App Key: <code>SHA256(sorted_params + app_key)</code>. See <a href="https://docs.pagsmile.com/reference/payout/security">Security</a>.</td></tr></tbody></table>

### Request Body

<table><thead><tr><th width="180">Name</th><th width="100">Type</th><th width="120">Required</th><th width="260">Constraints</th><th>Description</th></tr></thead><tbody><tr><td><code>date</code></td><td>string</td><td>Required</td><td>For a daily statement, use <code>YYYY-MM-DD</code>. For a monthly statement, use <code>YYYY-MM-MO</code>.</td><td>Statement period to retrieve. For example, <code>2026-04-15</code> retrieves the daily statement for April 15, 2026, while <code>2026-04-MO</code> retrieves the monthly statement for April 2026.</td></tr><tr><td><code>currency</code></td><td>string</td><td>Required</td><td>The currency must be enabled for the merchant's Payout account.</td><td>Statement currency. Supported values include <code>USD</code>, <code>GBP</code>, <code>EUR</code>, <code>BRL</code>, <code>MXN</code>, <code>COP</code>, <code>CLP</code>, <code>PEN</code>, and other currencies enabled for the merchant account.</td></tr><tr><td><code>timestamp</code></td><td>integer</td><td>Required</td><td>Current Unix timestamp in seconds. It must be within 15 seconds before or after the current server time.</td><td>Time when the request is sent.</td></tr></tbody></table>

{% hint style="warning" %}
Generate a new `timestamp` immediately before sending each request. The API rejects requests when the timestamp differs from the current server time by more than 15 seconds.
{% endhint %}

### Daily Statement

Set `date` to the required calendar date in `YYYY-MM-DD` format.

#### Daily Request Sample

```json
{
  "date": "2026-04-15",
  "currency": "USD",
  "timestamp": 1792060006
}
```

The daily statement ZIP file uses the following naming format:

```
{merchant_id}_{currency}_{YYYYMMDD}.zip
```

Example:

```
https://static.transfersmile.com/statement/2026/04/15/{merchant_id}_USD_20260415.zip
```

#### Daily Statement Sample

Download the following sample to view the CSV format of a daily Payout statement:

### Monthly Statement

Set the day portion of `date` to `MO`. For example, use `2026-04-MO` to retrieve the statement for April 2026.

#### Monthly Request Sample

```json
{
  "date": "2026-04-MO",
  "currency": "CRC",
  "timestamp": 1792060006
}
```

The monthly statement is stored under the first day of the selected month and uses the `monthly_` filename prefix:

```
monthly_{merchant_id}_{currency}_{YYYYMM01}.zip
```

Example:

```
https://static.transfersmile.com/statement/2026/04/01/monthly_{merchant_id}_CRC_20260401.zip
```

#### Monthly Statement Sample

Download the following sample to view the CSV format of a monthly Payout statement:

Replace `timestamp` with the current Unix timestamp in seconds and generate `Authorization` using the final Request Body values.

### Response

#### Statement Available

When the requested statement has been generated, `url` contains the download address and `crypto` contains the password required to extract the ZIP archive.

```json
{
  "code": 200,
  "msg": "success",
  "time": 1792060006,
  "data": {
    "url": "https://static.transfersmile.com/statement/2026/04/01/monthly_94FAC559AB097B03ABA675E7E9B68548_CRC_20260401.zip",
    "crypto": "MB3tNE"
  }
}
```

#### Statement Not Available

When no generated statement is available for the requested date and currency, the request still returns `code` `200`, but `url` and `crypto` are empty.

```json
{
  "code": 200,
  "msg": "success",
  "time": 1792059821,
  "data": {
    "url": "",
    "crypto": ""
  }
}
```

### Response Body

<table><thead><tr><th width="200">Parameter</th><th width="110">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>code</code></td><td>integer</td><td>Response code. <code>200</code> indicates that the request was processed successfully.</td></tr><tr><td><code>msg</code></td><td>string</td><td>Response message.</td></tr><tr><td><code>time</code></td><td>integer</td><td>Unix timestamp in seconds indicating when the response was generated.</td></tr><tr><td><code>data</code></td><td>object</td><td>Statement download information. This object contains the fields described below.</td></tr><tr><td><code>url</code></td><td>string</td><td>HTTPS URL of the generated password-protected ZIP statement. An empty value indicates that no generated statement was found.</td></tr><tr><td><code>crypto</code></td><td>string</td><td>Password used to extract the ZIP archive. An empty value indicates that no generated statement was found.</td></tr></tbody></table>

### Statement File

Download the ZIP archive from `url` and extract it using `crypto`. The archive contains the statement in CSV format.

#### Statement Columns

Daily and monthly statements use the following columns:

<table><thead><tr><th width="230">Column</th><th>Description</th></tr></thead><tbody><tr><td><code>Date</code></td><td>UTC transaction date.</td></tr><tr><td><code>Time</code></td><td>UTC transaction time.</td></tr><tr><td><code>TimeZone</code></td><td>Time zone of the statement record. The current value is <code>UTC</code>.</td></tr><tr><td><code>Merchant ID</code></td><td>Pagsmile merchant ID.</td></tr><tr><td><code>App Name</code></td><td>Name of the application associated with the transaction.</td></tr><tr><td><code>Country/Country Code</code></td><td>Destination country or country code associated with the payout.</td></tr><tr><td><code>Payment ID</code></td><td>Pagsmile payout transaction ID.</td></tr><tr><td><code>Reference ID</code></td><td>Merchant-defined payout reference ID.</td></tr><tr><td><code>Payout Method</code></td><td>Payout method used for the transaction.</td></tr><tr><td><code>Transaction Type</code></td><td>Account activity type, such as <code>payout</code>, <code>deduct</code>, <code>refund</code>, <code>partial_refund</code>, <code>deposit</code>, or <code>withdraw</code>, when applicable.</td></tr><tr><td><code>Opposite Name</code></td><td>Name of the beneficiary or counterparty associated with the account activity.</td></tr><tr><td><code>Applied Amount</code></td><td>Transaction amount applied to the account activity. Payout debits are represented as negative values.</td></tr><tr><td><code>Applied Currency</code></td><td>Currency of the applied amount.</td></tr><tr><td><code>Settlement Amount</code></td><td>Amount posted to the settlement account. Payout debits are represented as negative values.</td></tr><tr><td><code>Settlement Currency</code></td><td>Currency of the settlement amount.</td></tr><tr><td><code>Exchange Rate</code></td><td>Effective exchange rate recorded for the transaction.</td></tr><tr><td><code>Payer Processing Fee</code></td><td>Processing fee borne by the merchant. A debit is represented as a negative value.</td></tr><tr><td><code>Payee Processing Fee</code></td><td>Processing fee borne by the beneficiary. A debit is represented as a negative value.</td></tr><tr><td><code>Tax</code></td><td>Tax posted for the payout. A debit is represented as a negative value.</td></tr><tr><td><code>Net Amount</code></td><td>Net amount applied to the account balance. A payout debit is represented as a negative value.</td></tr><tr><td><code>Balance</code></td><td>Account balance after the statement record is applied.</td></tr><tr><td><code>Description</code></td><td>Reserved description field.</td></tr></tbody></table>

{% hint style="info" %}
For merchant accounts configured to receive a combined Payin and Payout statement, the column is named `Payment Method` instead of `Payout Method`, and a final `Business Type` column is added with a value of `Payin` or `Payout`.
{% endhint %}
