Skip to main content
GET
List remittances

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

type
enum<string>

Operação que originou a remessa. WITHDRAWAL: envio do remetente para um beneficiário no Brasil via Pix. Enum extensível: ignore tipos desconhecidos.

Available options:
WITHDRAWAL
from
string<date-time>
to
string<date-time>
status
enum<string>
Available options:
PROCESSING,
ON_HOLD,
COMPLETED,
REJECTED,
FUNDS_HELD_BRL,
RETURNED
payoutStatus
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
EXPIRED,
RETURNED
senderId
string
quoteId
string
fundingMode
enum<string>

Remessas pela modalidade de funding (funding.mode).

Available options:
PREFUNDED,
CREDIT,
INVENTORY
inventoryId
string

Remessas financiadas pelo Inventory Lot informado (rastreabilidade de utilização do lote).

settlementId
string
cursor
string

Cursor opaco retornado em pagination.nextCursor.

limit
integer
default:20
Required range: 1 <= x <= 100
externalId
string
beneficiaryTaxId
string

Response

Paginated remittance list

data
object[]
required
pagination
object
required