Sign in

v1

latestOpenAPI 3.1.02026-07-2432337285.3 KB
Accounts

List Account Movements

Retrieves a paginated list of debit/credit movements.

get/movements/

Query parameters

account_idstring

If provided, only return movements for this specific account ID.

If provided, only return movements for this specific account ID.

include_child_companiesboolean

If set to true, include movements from accounts owned by any child companies of the authenticated company. Default: false.

If set to true, include movements from accounts owned by any child companies of the authenticated company. Default: false.

date_fromstring

ISO 8601 timestamp (UTC). Only include movements on or after this time.

ISO 8601 timestamp (UTC). Only include movements on or after this time.

date_tostring

ISO 8601 timestamp (UTC). Only include movements on or before this time.

ISO 8601 timestamp (UTC). Only include movements on or before this time.

page_numberinteger

Page index (1-based). Results start from page 1 by default.

Page index (1-based). Results start from page 1 by default.

page_sizeinteger

Maximum number of movements to return per page. Defaults to 50.

Maximum number of movements to return per page. Defaults to 50.

movement_idstring

If provided, only return the movement with this ID.

If provided, only return the movement with this ID.

company_idinteger

If provided, filter movements by this company ID.

If provided, filter movements by this company ID.

operation_type'PAYOUT' | 'PAYOUT_REFUND' | 'INTERNAL_TRANSFER' | 'INTERNAL_TRANSFER_REFUND' | 'PAYIN' | 'PAYIN_REFUND' | 'PAYIN_REFUND_BOUNCE' | 'CREDIT' | 'CREDIT_REFUND' | 'CREDIT_REFUND_BOUNCE' | 'DEBIT' | 'FEE' | 'TAX'

If provided, only return movements with this operation type.

operation_idstring

If provided, only return movements with this operation ID.

If provided, only return movements with this operation ID.

voucher_idstring

If provided, only return movements with this voucher ID.

If provided, only return movements with this voucher ID.

currency'BRL' | 'BRLA' | 'MXN' | 'ARS' | 'COP' | 'CLP' | 'BOB' | 'PYG' | 'SGD' | 'PEN' | 'EUR' | 'GBP' | 'USD' | 'USDT' | 'USDC' | 'UYU' | 'USDC_POL' | 'USDT_POL' | 'EURC_BASE' | 'USDC_BASE' | 'USDT_BASE' | 'USDC_ETH' | 'USDT_ETH' | 'EURC_ETH' | 'USDC_TEMPO' | 'USDT_TEMPO' | 'EURC_TEMPO' | 'BRLA_ETH' | 'BRLA_POL' | 'BRLA_BASE' | 'TGBP_ETH' | 'TGBP_POL' | 'TGBP_BASE'
country'BR' | 'AR' | 'CO' | 'CL' | 'BO' | 'PY' | 'SG' | 'PE' | 'MX' | 'UY' | 'US' | 'EU' | 'XX' | 'GB'
limitinteger
cursorstring

Headers

x-company-idinteger

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

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

Response

Successful Response

next_cursorstring
has_moreboolean
status'success'