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.
Path Parameters
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.
ISO 4217 currency code or stablecoin ticker. The maximum decimal scale of an AmountValue paired with this asset depends on the asset:
Requests accept only these three assets. Any other asset fails with 400 INVALID_DATA (INVALID_ENUM).
BRL, USDT, USDC "BRL"
What compliance last asked of you for this instruction. It reflects the latest request of the compliance analysis, so it can lag the analysis by a few seconds, like currentState and the BENEFICIARY_INSTRUCTION_ACTION_REQUIRED webhook. Every response that carries the instruction returns the same value, including the 201 that adds an instruction. All four groups are empty for an instruction whose review has not started, has not been read yet or has already been decided.