List funding instructions

Retrieves funding instructions for depositing into an account across all available payment rails.

GET /api/accounts/{accountId}/fundingInstructions

List funding instructions

cURL

curl --request GET \
  --url https://api.sandbox.tracefinance.com/api/accounts/{accountId}/fundingInstructions \
  --header 'Authorization: Bearer <token>'

200

mixed

{ "data": [ { "asset": "BRL", "rail": "PIX_KEY", "keyType": "CNPJ", "key": "12345678000101" }, { "asset": "BRL", "rail": "TED", "bankCode": "001", "branch": "0001", "accountNumber": "123456-7", "accountType": "CHECKING" } ], "meta": { "previousCursor": null, "nextCursor": null, "total": 2 } }

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

limit · integer · default: 10

Maximum number of items to return. Defaults to 10.

Required range: 1 <= x <= 100

cursor · string

Opaque cursor for fetching the next or previous page.

direction · enum<string>

Direction of pagination relative to the cursor.

Available options: NEXT, PREVIOUS

sortOrder · enum<string> · default: DESCENDING

Sort order for results. Defaults to DESCENDING.

Available options: ASCENDING, DESCENDING

filters · string

Filter expression using LHS Brackets syntax (field[operator]=value). Combine multiple conditions with and(...), or(...), or ; (implicit AND). See the Filtering guide for the full operator catalog and examples.

Response

200

application/json

Paginated list of funding instructions.

data · (PIX key · object | PIX static QR code · object | TED · object | Boleto · object | Crypto wallet · object)[] · required

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

PIX key

PIX static QR code

TED

Boleto

Crypto wallet

Show child attributes

meta · object · required

Cursor-based pagination metadata.

Show child attributes