# List all settlements

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

Endpoint: GET /settlements
Version: 1.0.0
Security: JWT

## Query parameters:

  - `before` (string)
    ISO-8601 timestamp in UTC to filter resources created before this time. Use this to avoid Page drift issue. See Pagination parameters for more details.
    Example: "2025-02-18T12:03:44Z"

  - `after` (string)
    ISO-8601 timestamp in UTC to filter resources created after this time. Use this to avoid Page drift issue. See Pagination parameters for more details.
    Example: "2025-01-18T12:03:44Z"

  - `per_page` (integer)
    Number of resources per page. Should be between 1 and 100.

  - `page` (integer)
    Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (string)
    The unique identifier for the settlement.
    Example: "setl_6878e266jt1P3"

  - `data.status` (string)
    The status of the settlement.
    Example: "success"

  - `data.payment_method` (string)
    The payment method used for the settlement.
    Example: "swift_transfer"

  - `data.amount` (number)
    The amount of the settlement in cents. For example, 1000 cents is $10.00. The currency is determined by the currency field.
    Example: 1000

  - `data.currency` (string)
    The currency in which the settlement is made. The currency code is in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, USD.
    Example: "USD"

  - `data.fees` (object)
    The fees associated with the settlement.

  - `data.fees.fx_fee` (object)
    The foreign-exchange fee charged for the settlement in cents.

  - `data.fees.fx_fee.amount` (number)
    The amount of the foreign exchange fee in cents. For example, 1000 cents is $10.00.
    Example: 10

  - `data.fees.fx_fee.currency` (string)
    The currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, USD.
    Example: "USD"

  - `data.fees.txn_fee` (object)
    The transaction fee charged for the settlement in cents.

  - `data.fees.txn_fee.amount` (number)
    The amount of the transaction fee in cents. For example, 1000 cents is $10.00.
    Example: 10

  - `data.utr` (string)
    The Unique Transaction Reference (UTR) for the settlement.
    Example: "1568176960vxp0rj"

  - `data.created_at` (string)
    The creation timestamp of the settlement.
    Example: "2024-12-06T11:38:37.130Z"

  - `data.updated_at` (string)
    The last update timestamp of the settlement.
    Example: "2024-12-06T11:38:37.130Z"

  - `page_meta` (object)

  - `page_meta.current` (integer)
    The current page number.
    Example: 2

  - `page_meta.previous` (integer,null)
    The previous page number.
    Example: 1

  - `page_meta.next` (integer,null)
    The next page number.
    Example: 3

  - `page_meta.per_page` (integer)
    The number of items per page.
    Example: 20

  - `page_meta.pages` (integer)
    The total number of pages.
    Example: 10

  - `page_meta.count` (integer)
    The total number of items.
    Example: 200

## Response 400 fields (application/json):

  - `error` (string)
    Enum: "Bad Request"

  - `message` (string)
    Error message indicating which parameter was invalid