Skip to main content

Documentation

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

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

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

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

  • Get merchant settlement report

  • 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'
    
  • {
      "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"
        }
      ]
    }