Get a payment instruction
Retrieves one payment instruction of a beneficiary, including its review status.
Authorizations
JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.
Headers
API version. Omit to use the default version.
"1"
Path Parameters
UUID of the beneficiary.
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.
"pi-a1b2c3d4-5e6f-7890-abcd-ef1234567890"
ISO 4217 currency code or stablecoin ticker. The maximum decimal scale of an AmountValue paired with this asset depends on the asset:
BRL, USDT, USDC "BRL"
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.
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.
- PIX key
- PIX bank instruction
- PIX static QR code
- Boleto
- Crypto wallet
"2026-04-14T10:30:00Z"
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.
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.
Custody arrangement for the instruction. Present only for the CRYPTO rail; null for all other rails.