# List All Settlements

Retrieve a list of .

For details on how to query endpoints using the available parameters, see Query Parameters.

Endpoint: GET /settlements
Version: 2022-02-01
Security: BasicAuth

## Query parameters:

  - `created_at.gte` (string)
    Filter where  is after the given date.
    Example: "2022-09-27T11:21:23"

  - `created_at.lte` (string)
    Filter where  is before the given date.
    Example: "2026-09-27T11:21:23"

  - `updated_at.gte` (string)
    Filter where  is after the given date.
    Example: "2022-09-27T11:21:23"

  - `updated_at.lte` (string)
    Filter where  is before the given date.
    Example: "2026-09-27T11:21:23"

  - `application_id` (string)
    Filter by  ID.
    Example: "APc9vhYcPsRuTSpKD9KpMtPe"

  - `total_amount` (integer)
    Filter by a  equal to the given value.

  - `total_amount.gte` (integer)
    Filter by an  greater than or equal to the given value.
    Example: 2

  - `total_amount.gt` (integer)
    Filter by an  greater than the given value.
    Example: 2

  - `total_amount.lte` (integer)
    Filter by an  less than or equal to the given value.
    Example: 2000

  - `total_amount.lt` (integer)
    Filter by an  less than the given value.
    Example: 2000

  - `status` (string)
    Filter by the status of the . Available values include: Merchants only receive payouts when  are . For more information, see Payouts.
    Enum: "APPROVED", "AWAITING_APPROVAL", "PENDING"

  - `merchant_id` (string)
    Filter by  ID.

  - `is_exception` (boolean)
    Filter to return if settlement is an exception settlement.

  - `transfer_id` (string)
    Filter by a  a  has accrued.

  - `split_transfer_id` (string)
    Filter by a  a  has accrued.

  - `funding_transfer_id` (string)
    Filter by a  a  has created.

## Response 200 fields (application/json):

  - `page` (object)
    Details the page that's returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.next_cursor` (string,null)
    The cursor to use for the next page of results.

  - `_embedded` (object)
    List of  objects.

  - `_embedded.settlements` (array)
    resource.

  - `_embedded.settlements.id` (string)
    The ID of the  resource.

  - `_embedded.settlements.created_at` (string)
    Timestamp of when the object was created.

  - `_embedded.settlements.updated_at` (string)
    Timestamp of when the object was last updated.

  - `_embedded.settlements.application` (string)
    The ID of the  resource the  was created under.

  - `_embedded.settlements.currency` (string)
    ISO 4217 3 letter currency code.
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL"

  - `_embedded.settlements.destination` (string,null)
    ID of the  where funds will be sent.
    Example: "PIxxxxxxxxxxxxxxxxxx"

  - `_embedded.settlements.funds_flow` (string,null)
    Details how funds will be dispersed in the  (usually ).

  - `_embedded.settlements.identity` (string)
    The ID of the  used to create the  resource.

  - `_embedded.settlements.is_exception` (boolean)
    Returns true if settlement contains items that were removed from a previous settlement resource.

  - `_embedded.settlements.merchant_id` (string)
    The ID of the  used to create the  resource.

  - `_embedded.settlements.net_amount` (integer)
    The amount in cents that will be deposited into the merchant's bank account.

  - `_embedded.settlements.payment_type` (string,null)
    The type of  used in the  (or the original payment).

  - `_embedded.settlements.payout_profile_id` (string)
    The id of the  that was used to generate the settlement.

  - `_embedded.settlements.processor` (string)
    Name of the  processor.

  - `_embedded.settlements.status` (string)
    The status of the . Available values include: Merchants only receive payouts when  are  and receive the resulting funding  . For more information, see [Payouts](/guides/payouts/).
    Enum: "APPROVED", "AWAITING_APPROVAL", "PENDING"

  - `_embedded.settlements.tags` (object,null)
    Include up to 50  pairs to annotate requests with custom metadata.
- Maximum character length for individual  is 40.
- Maximum character length for individual  is 500.
(For example, , , )

  - `_embedded.settlements.total_amount` (integer)
    Total amount of the  (in cents).

  - `_embedded.settlements.total_fee` (integer)
    Sum of the fees in the .

  - `_embedded.settlements.total_fees` (integer)
    Sum of the fees 
(including Subcription Billing) in the .

  - `_embedded.settlements.type` (string)
    Type of .
    Enum: "MERCHANT_REVENUE", "PLATFORM_FEE", "PARTNER_FEE", "NOOP", "MERCHANT", "APPLICATION", "PLATFORM"

  - `_embedded.settlements._links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these  to make your follow-up requests and quickly access relevant IDs.

  - `_embedded.settlements._links.application` (object)
    Link to the  the resource was created under.

  - `_embedded.settlements._links.application.href` (string)

  - `_embedded.settlements._links.credits` (object)

  - `_embedded.settlements._links.debits` (object)

  - `_embedded.settlements._links.disputes` (object)

  - `_embedded.settlements._links.fees` (object)

  - `_embedded.settlements._links.funding_transfers` (object)

  - `_embedded.settlements._links.identity` (object)

  - `_embedded.settlements._links.reversals` (object)

  - `_embedded.settlements._links.self` (object)
    Link to the resource that was used in the request.

  - `_embedded.settlements._links.transfers` (object)

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 406 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)