---
title: "List all settlements"
method: GET
path: "/api/v1/settlements"
tags: ["Settlements"]
---

# List all settlements

`GET /api/v1/settlements`

## Request

- Base URL: `https://api.crossborder.jiopay.co.in`
- URL: `https://api.crossborder.jiopay.co.in/api/v1/settlements`
- Auth: HTTP bearer

Returns a list of your settlements. The settlements are returned sorted by creation date, with the most recent settlement appearing first.

## Query parameters

- `before` string
- `after` string
- `per_page` integer
- `page` integer

## Response `200`

OK

- SettlementListResponse
  - `data` SettlementResponse[]: List of settlements, most recently created first.
    - `id` string: The unique identifier for the settlement.
    - `status` string: The status of the settlement.
    - `payment_method` string: The payment method used for the settlement.
    - `amount` number: The amount of the settlement in cents. For example, 1000 cents is $10.00. The currency is determined by the currency field.
    - `currency` string: The currency in which the settlement is made. The currency code is in ISO 4217 format. For example, USD.
    - `fees` SettlementFees: The fees associated with the settlement.
      - `fx_fee` MoneyAmount
        - `amount` number: Amount in cents. For example, 1000 cents is $10.00.
        - `currency` string: The currency code in ISO 4217 format. For example, USD.
      - `txn_fee` MoneyAmount
        - `amount` number: Amount in cents. For example, 1000 cents is $10.00.
        - `currency` string: The currency code in ISO 4217 format. For example, USD.
    - `utr` string: The Unique Transaction Reference (UTR) for the settlement.
    - `created_at` string: The creation timestamp of the settlement.
    - `updated_at` string: The last update timestamp of the settlement.
  - `page_meta` PageMeta
    - `current` integer: The current page number.
    - `previous` integer, nullable: The previous page number.
    - `next` integer, nullable: The next page number.
    - `per_page` integer: The number of items per page.
    - `pages` integer: The total number of pages.
    - `count` integer: The total number of items.

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/jiopay/apis/cross-border.md) - [All operations](https://skmtc.dev/jiopay/apis/cross-border/llms.txt) - [OpenAPI document](https://skmtc.dev/jiopay/apis/cross-border/revisions/b3e97f5918d4?raw)