Saltar al contenido principal
GET
Read a scheduled payment's receipt

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

schedule_id
string
requerido

Schedule identifier.

Ejemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Respuesta

OK

amount
string
requerido

Amount to settle, in BRL.

cancellationCutoff
string<date-time>
requerido

The deadline recorded for this schedule -- the one the payer was told, not one recomputed today.

payee
object
requerido

The payee as photographed at creation.

payer
object
requerido

The payer as photographed at creation.

scheduleId
string
requerido

Schedule identifier.

scheduledAt
string<date-time>
requerido

When the schedule was registered.

scheduledDate
string<date>
requerido

Civil settlement date in AAAA-MM-DD.

description
string

The payer's memo, exactly as stored. Not escaped here and not escaped on the way in.

brCodePayload
string

The BR Code the payer submitted, stored and returned VERBATIM -- re-serialising it would break the CRC-16 the standard embeds, and the receipt would show a code that pays nobody. Present only when initiationType is QR_CODE.

Ejemplo:

"00020101021226900014br.gov.bcb.pix2568qrcodepix.exemplo.com.br/cobv/8f3a1c2d4e5b6f7a8b9c0d1e2f3a4b5c52040000530398654071500.005802BR5919Mercado Central LTDA6008BRASILIA62070503***6304A1B2"

txId
string

Identifier of the due-date collection this schedule pays, as carried by the BR Code. Present only when initiationType is QR_CODE.

Ejemplo:

"COBV20260910MERCADOCENTRAL0001"