Skip to main content
GET
Read a scheduled payment's receipt

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

schedule_id
string
obrigatório

Schedule identifier.

Exemplo:

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

Resposta

OK

amount
string
obrigatório

Amount to settle, in BRL.

cancellationCutoff
string<date-time>
obrigatório

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

payee
object
obrigatório

The payee as photographed at creation.

payer
object
obrigatório

The payer as photographed at creation.

scheduleId
string
obrigatório

Schedule identifier.

scheduledAt
string<date-time>
obrigatório

When the schedule was registered.

scheduledDate
string<date>
obrigatório

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 (RF-16).