---
title: "Get merchant settlement report"
source_url: https://docs.rapyd.net/en/get-merchant-settlement-report.html
lang: en
---

# Get merchant settlement report

Settlement-level report. Each row represents a single settlement batch. The `settlement_id` field links back to the transaction-level reports.

**Pagination****:** Request page 0 to retrieve the first page. The response includes a `total_pages` field that tells you how many pages exist for that date. If there is more than one page, request the remaining pages one at a time (page 1, page 2, and so on up to `total_pages`), and combine the `data` array from each page to assemble the full day's records.

See also [Merchant Settlement Report](https://docs.rapyd.net/en/merchant-settlement-report.md "Merchant Settlement Report")

### Parameters

### Request Path Parameters

- - yyyy
  - Four-digit year (for example, 2026).

  - mm
  - Two-digit, zero-padded month (for example, 06).

  - dd
  - Two-digit, zero-padded day (for example, 18).

  - page
  - Page number, starting from 0 (the first page). Use `total_pages` in the response to paginate.

### Request Header Parameters

- - access_key
  - Unique access key provided by Rapyd for each authorized user.

    See [Developers](https://docs.rapyd.net/en/developers.md "Developers").
- - Content-Type
  - Indicates that the data appears in JSON format. Set to **application/json**.
- - salt
  - Random string. Recommended length: 8-16 characters.
- - signature
  - Signature calculated for each request individually.

    See [Request Signatures](https://docs.rapyd.net/en/request-signatures.md "Request Signatures").
- - timestamp
  - Timestamp for the request, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds).

### 200 OK Response

- - total_pages
  - Total pages available for the requested date. Use this field value to determine how many additional requests are needed.

  - current_page
  - The page number returned in this response.

  - total_records
  - Total number of report records across all pages, for completeness verification.

  - data
  - Array of report record objects. Field definitions vary by report type.

    - account_id
    - Merchant account identifier or alias.

    - account_number
    - Bank account number for the settlement destination.

    - bank
    - Bank identifier for the settlement destination.

    - wallet_id
    - Wallet ID associated with the settlement.

    - type
    - Settlement type (for example, Collections).

    - settlement_date
    - Date the settlement was or is due to be processed (ISO 8601 UTC).

    - settlement_currency
    - Currency in which the settlement is paid out (ISO 4217).

    - settlement_amount
    - Total amount settled in the settlement currency.

    - settlement_wallet_account_currency
    - Currency of the wallet account receiving the settlement.

    - settlement_amount_in_wallet_account_currency
    - Settlement amount expressed in wallet account currency.

    - prev_negative_settlement
    - Carry-forward from a previous negative settlement, if any. May be returned as `null`.

    - settlement_reference_id
    - Unique reference identifier for the settlement event.

    - static_reference_id
    - Static reference identifier. May be returned as `null`.

    - reserve_currency
    - Currency of any held reserve amount. May be returned as `null`.

    - reserve_amount_in_reserve_currency
    - Amount held in reserve, in the reserve currency. May be returned as `null`.

    - reserve_amount_in_settlement_currency
    - Reserve amount expressed in settlement currency. May be returned as `null`.

    - initiator
    - Entity that initiated the settlement (for example, Rapyd).

    - client_reference
    - Client-supplied reference for the settlement. May be returned as `null`.

    - settlement_id
    - Unique batch identifier. Matches `settlement_id` in transaction-level reports.

    - original_settlement_date
    - Original scheduled settlement date, before any adjustments (ISO 8601 UTC). May be returned as `null`.

    - wallet_address
    - Wallet address if applicable (for example, crypto settlements). May be returned as `null`.

- /v1/recon/partitioned_reports/merchant_settlement_report/{yyyy}/{mm}/{dd}/{page}

- Get merchant settlement report
- ```curl
  curl -X GET
  https://files.rapyd.net/v1/recon/partitioned_reports/merchant_settlement_report/{yyyy}/{mm}/{dd}/{page}
  -H 'access_key: your-access-key-here' \
  -H 'Content-Type: application/json' \
  -H 'salt: your-random-string-here' \
  -H 'signature: your-calculated-signature-here' \
  -H 'timestamp: your-unix-timestamp-here'
  ```
- ```json
  {
    "total_pages": 0,
    "current_page": 0,
    "total_records": 0,
    "data": [
      {
        "account_id": "string",
        "account_number": "string",
        "bank": "string",
        "wallet_id": "string",
        "type": "string",
        "settlement_date": "2019-08-24T14:15:22Z",
        "settlement_currency": "string",
        "settlement_amount": 0.1,
        "settlement_wallet_account_currency": "string",
        "settlement_amount_in_wallet_account_currency": 0.1,
        "prev_negative_settlement": 0.1,
        "settlement_reference_id": "string",
        "static_reference_id": "string",
        "reserve_currency": "string",
        "reserve_amount_in_reserve_currency": 0.1,
        "reserve_amount_in_settlement_currency": 0.1,
        "initiator": "string",
        "client_reference": "string",
        "settlement_id": "string",
        "original_settlement_date": "2019-08-24T14:15:22Z",
        "wallet_address": "string"
      }
    ]
  }
  ```