Pular para o conteúdo principal
GET
Ver transferência Pix

Autorizações

x-access-id
string
header
obrigatório

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

X-PoP-Challenge
string
header
obrigatório

Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5 minutes of server time.

X-PoP-Format
string
header
obrigatório

Must be 'service-account' for service account authentication

X-PoP-Signature
string
header
obrigatório

EdDSA signature of the request in base64 format. Signs: uri:method:body:timestamp

Parâmetros de caminho

id
integer<int64>
obrigatório

Transfer identifier

Resposta

Transfer retrieved successfully

amount_in_cents
integer<int64>
obrigatório

Transfer amount in centavos.

beneficiary
Chave Pix · object
obrigatório

Beneficiary and destination details.

created_at
string<date-time>
obrigatório

Transfer creation timestamp (UTC, RFC 3339).

Exemplo:

"2026-05-28T14:30:00Z"

id
integer<int64>
obrigatório

Transfer identifier.

status
enum<string>
obrigatório

Current transfer status.

Opções disponíveis:
awaiting_approval,
pending,
processing,
success,
cancelled,
failed
display_description
string | null

Description shown to the beneficiary.

end_to_end_id
string | null

PIX End-to-End ID assigned after successful processing.

external_reference_id
string | null

Client-provided reference identifier.

failed_message
string | null

Failure reason when status is failed.

scheduled_date
string<date> | null

Scheduled execution date (YYYY-MM-DD). Null when executed immediately.

Exemplo:

"2026-06-01"

transaction_id
integer<int64> | null

Ledger transaction identifier, available after processing.