COconfirmo
Settlement

List merchant Settlements

Returns list of merchant's Settlements filtered by specific parameters.

get/v3/settlements

Request

  • Base URL
    https://confirmo.net/api
  • URL
    https://confirmo.net/api/v3/settlements
  • Auth
    HTTP bearer

Query parameters

limitinteger required

Maximum number of Settlements to return.

offsetinteger required

Number of Settlements to skip.

order'createdAt,asc' | 'createdAt,desc' | 'amount,asc' | 'amount,desc' required

Sort column and the order direction (append ',asc' or ',desc' to the column name)

searchStringstring

Search text to filter by the Settlement ID, the account number or the crypto address.

statusesstring[]

Filter by the Settlement status (multiple values supported, comma-separated)

createdAtFromstring

Filter by the creation date - start timestamp (Unix epoch in seconds)

createdAtTostring

Filter by the creation date - end timestamp (Unix epoch in seconds)

currency'BTC' | 'CZK' | 'ETH' | 'EUR' | 'GBP' | 'HUF' | 'LTC' | 'PLN' | 'POL' | 'SOL' | 'TRX' | 'USD' | 'USDC' | 'USDT'

The currency in which the Settlement will be paid out. Merchant gets paid in this currency, when it is assigned to an invoice as settlement currency

Example:EUR

Filter by the Settlement currency.

Response

OK

limitinteger

The number of returned items.

offsetinteger

The number of skipped items.

orderstring

The sort column and the order of returned items.

querystring

The searched string in items.

totalCountinteger

The total number of items owned by the merchant.

Example response

{
  "data": [
    {
      "account": "CZ65 0800 0000 192 5399 0014",
      "createdAt": 1506079172,
      "cryptoWithdrawalAmountSum": 100,
      "currency": "EUR",
      "id": "set748ep4e5x",
      "osTransactionAmountSum": 100,
      "overpaymentAmountSum": 100,
      "substatus": "SCREENING_IN_PROGRESS"
    }
  ],
  "limit": 20,
  "order": "createdAt, desc",
  "totalCount": 150
}

Changes

No recorded changes to this operation across all 1 revision of this API.