Skip to main content
GET
List funding instructions

Authorizations

Authorization
string
header
required

JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.

Headers

X-Trace-Version
string

API version. Omit to use the default version.

Example:

"1"

Path Parameters

accountId
string<uuid>
required

UUID of the account.

Query Parameters

asset
enum<string>

Filter results by asset code. ISO 4217 currency code or stablecoin ticker. The maximum decimal scale of an AmountValue paired with this asset depends on the asset:

Available options:
BRL,
USDT,
USDC
Example:

"BRL"

rail
enum<string>

Filter results by payment rail. Payment rail used to fund a deposit.

Available options:
PIX_KEY,
PIX_STATIC_QR_CODE,
PIX_DYNAMIC_QR_CODE,
PIX_BANK_INSTRUCTION,
BOLETO,
CRYPTO,
TED,
WIRE,
SWIFT,
SEPA,
ACH

Response

List of funding instructions.

A funding instruction for depositing into an account. Discriminated by type.

asset
enum<string>
required

ISO 4217 currency code or stablecoin ticker. The maximum decimal scale of an AmountValue paired with this asset depends on the asset:

Available options:
BRL,
USDT,
USDC
Example:

"BRL"

type
enum<string>
required

Funding instruction shape. Each value maps to one variant of FundingInstructionResponse.

Available options:
PIX_KEY
rail
enum<string>
required

Payment rail used to fund a deposit.

Available options:
PIX_KEY
keyType
enum<string>
required

PIX key type.

Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
RANDOM
Example:

"CNPJ"

key
string
required

The PIX key value.

Example:

"12345678000101"

accountIdentifier
string | null

Optional account identifier exposed by the underlying provider, useful when the same key is shared across multiple accounts.

Example:

null