COconfirmo
Payout

List Payouts

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

get/v3/payouts

Request

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

Query parameters

status'draft' | 'prepared' | 'pending_verification' | 'confirmed' | 'canceled' | 'expired' | 'sending' | 'done'

Filter by the Payout status.

createdAtFrominteger

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

createdAtTointeger

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

currencyFrom'BTC' | 'CZK' | 'EUR' | 'USD' | 'USDC' | 'USDT'

Balance of this asset is affected by the payout.

Example:EUR

Filter by source currency (the currency being sent)

currencyTo'BTC' | 'LTC'

Filter by the target cryptocurrency. Superseded by paymentMethodId

paymentMethodIdstring
Example:BITCOIN-BLOCKCHAIN-MAINNET-BTC-CURRENCY

Filter by the target payment method ID. Valid values are the 'id' values returned by GET /api/v3/crypto-payment-methods.

searchStringstring

Search text to filter by the Payout ID, the e-mail, the crypto address, the TXID or the reference.

limitinteger

Maximum number of Payouts to return.

offsetinteger

Number of Payouts to skip for pagination.

Response

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

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

{
  "limit": 20,
  "order": "createdAt, desc",
  "totalCount": 150
}

Changes

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