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

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

schedule_id
string
required

Schedule identifier.

Example:

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

Response

OK

amount
string
required

Amount to settle, in BRL.

cancellationCutoff
string<date-time>
required

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

payee
object
required

The payee as photographed at creation.

payer
object
required

The payer as photographed at creation.

scheduleId
string
required

Schedule identifier.

scheduledAt
string<date-time>
required

When the schedule was registered.

scheduledDate
string<date>
required

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).