Skip to main content
GET
Get a payment instruction

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

beneficiaryId
string<uuid>
required

UUID of the beneficiary.

paymentInstructionId
string<uuid>
required

UUID of the payment instruction.

Response

Payment instruction details.

A payment instruction on a beneficiary. Use address.rail to discriminate routing details — for beneficiary payment instructions it is one of PIX_KEY, PIX_BANK_INSTRUCTION, or CRYPTO.

id
string<uuid>
required
read-only
Example:

"pi-a1b2c3d4-5e6f-7890-abcd-ef1234567890"

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"

currentState
object
required

A single entry in a payment instruction's state history. Carries a status, optional reason (present only for REJECTED), and the time the state was entered.

address
PIX key · object
required

A payment route, discriminated by rail. Beneficiary payment instructions emit one of PIX_KEY, PIX_BANK_INSTRUCTION, or CRYPTO; other rails appear in operation responses.

createdAt
string<date-time>
required
read-only
Example:

"2026-04-14T10:30:00Z"

documents
Document · object[]
required
read-only

Compliance documents you have uploaded for the instruction. Empty until you upload one. This is what you sent — to know what is still wanted, read requirements.

requirements
object
required

What compliance is waiting on for this instruction, read live at request time. All four groups are empty for an instruction whose review has not started or has already been decided.

Example:
custodyDetail
object | null

Custody arrangement for the instruction. Present only for the CRYPTO rail; null for all other rails.