Payouts

List Payouts

Retrieve a paginated list of payouts.

get/

Request

  • Base URL
    https://app2test.infiniaweb.com/infinia_api/v2/payouts
  • URL
    https://app2test.infiniaweb.com/infinia_api/v2/payouts/
  • Auth
    HTTP basic

Query parameters

country'ARGENTINA' | 'BRAZIL' | 'MEXICO' | 'PARAGUAY' | 'PERU' | 'COLOMBIA' | 'CHILE' | 'EUROPE' | 'GLOBAL' | 'BOLIVIA' | 'UNITED_KINGDOM'
page_numberinteger

Default: 1

page_sizeinteger

Default: 50

payout_idstring

Payout ID

include_child_companiesboolean

If set to true, include payouts by any child companies of the authenticated company. Default: false.

date_fromstring

Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.

date_tostring

Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.

status'COMPLETED' | 'IN_PROGRESS' | 'FAILED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'ERROR'
currency'ARS' | 'USD' | 'BRL' | 'MXN' | 'PYG' | 'CLP' | 'PEN' | 'EUR' | 'GBP' | 'USDT' | 'USDC' | 'BOB' | 'EURC' | 'COP' | 'USDC_POL' | 'USDT_POL' | 'EURC_BASE' | 'USDC_BASE' | 'USDT_BASE' | 'USDC_ETH' | 'USDT_ETH' | 'EURC_ETH' | 'USDC_TEMPO' | 'USDT_TEMPO' | 'EURC_TEMPO' | 'OUSD' | 'OUSD_TEMPO' | 'USDC_MONAD' | 'USDT_MONAD' | 'OUSD_BASE' | 'OUSD_ETH' | 'OUSD_SOL' | 'GBP' | 'BRLA' | 'BRLA_POL' | 'BRLA_BASE' | 'BRLA_ETH' | 'TGBP' | 'TGBP_POL' | 'TGBP_BASE' | 'TGBP_ETH' | 'USDC_SOL' | 'USDT_SOL' | 'USDT_TRX' | 'MXNB' | 'MXNB_BASE'
amount_minnumber
amount_maxnumber
origin_idstring

Origin ID to filter payouts.

account_idinteger

Filter by a particular account referenced by its ID.

limitinteger
cursorstring

Headers

x-company-idinteger

ID of a child company for authentication. If not provided, the parent company will be authenticated.

Response

Successful Response

status'success' | ''
nextCursorstring
hasMoreboolean

Changes

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