Sign in

v1

latestOpenAPI 3.1.02026-08-0629140119.9 KB
PIX

Get Transfer

Retrieves a single PIX transfer by its ID for the authenticated account.

get/v1/transfers/{id}

Path parameters

idinteger required

Transfer identifier

Response

Transfer retrieved successfully

amount_in_centsinteger required

Transfer amount in centavos.

created_atstring date-time required

Transfer creation timestamp (UTC, RFC 3339).

display_descriptionstring nullable

Description shown to the beneficiary.

end_to_end_idstring nullable

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

external_reference_idstring nullable

Client-provided reference identifier.

failed_messagestring nullable

Failure reason when status is failed.

idinteger required

Transfer identifier.

scheduled_datestring date nullable

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

status'awaiting_approval' | 'pending' | 'processing' | 'success' | 'cancelled' | 'failed' required
transaction_idinteger nullable

Ledger transaction identifier, available after processing.

Example response

{
  "created_at": "2026-05-28T14:30:00Z",
  "scheduled_date": "2026-06-01"
}