Get scheduled payment by ID - V1

GET

/order/v1/banking/subscriptions/payments/{id}

• Production
• Sandbox

  Retrieve a scheduled payment by its ID.

  

NOTE: Please, to authenticate use the scope: “api://app-order-prd”

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string

The scheduled payment ID (UUID)

Responses

200

The resource was returned successfully

object

id

required

The unique id of the scheduled payment

string

Example

42efcabd-4e69-4402-ba55-389cee74d579

subscriptionId

required

The id of the subscription

string

Example

8d1d0fe6-36a3-4804-8868-31a35415903f

status

required

The status of the schedules payment

string

Allowed values: INITIAL PENDING ACCEPTED REJECTED COMPLETED ERROR CANCELED CANCELED_INSUFFICIENT_BALANCE

Example

ACCEPTED

statusHistory

required

The status history of the subscription

Array<object>

object

status

required

The status of the subscription when the status history was created

string

Allowed values: INITIAL PENDING ACCEPTED REJECTED COMPLETED ERROR CANCELED CANCELED_INSUFFICIENT_BALANCE

Example

PENDING

createdAt

required

The date and time when the resource was created, in ISO 8601 format (RFC 3339), UTC. Example: 2025-01-15T10:00:00Z

string

Example

2025-01-15T10:00:00Z

idempotencyKey

required

The idempotency key

string

Example

c3ac5273-ef68-42c7-b3a3-dfbfc040511d

purpose

required

The purpose of the scheduled payment

string

Allowed values: FIRST_ATTEMPT NEW_ATTEMPT_AFTER_DUE_DATE RESEND_DUE_TO_SETTLEMENT_ERROR

Example

FIRST_ATTEMPT

dueDate

required

The due date of the scheduled payment in ISO 8601 format (YYYY-MM-DD). Example: 2025-02-10

string

Example

2025-02-10

amount

required

The amount object of the scheduled payment

object

currency

required

The currency field.

string

Example

BRL

value

required

The value field.

string

Example

10.95

description

A optional description of the scheduled payment

string

Example

Scheduled monthly subscription payment

webhookUrl

required

The url to receive the updates about the scheduled payment

string

Example

https://example.com/schedule-payments

externalId

The external ID from the partner system

string

Example

3931268d-a0a2-44ce-8ca3-843db77d352e

endToEndId

The end to end ID from PIX

string

Example

E33630661202501190000000000001

orderId

The id of the order generated when the scheduled payment was paid. Present only after payment.

string

Example

8c385efb-a5c3-4b83-abf0-927c4b6ac5cb

createdAt

required

The date and time when the resource was created, in ISO 8601 format (RFC 3339), UTC. Example: 2025-01-15T10:00:00Z

string

Example

2025-01-15T10:00:00Z

updatedAt

The date and time when the resource was last updated, in ISO 8601 format (RFC 3339), UTC. Example: 2025-01-20T14:45:00Z

string

Example

2025-01-20T14:45:00Z

cancellations

The array of cancellations attempts

Array<object>

object

id

required

The unique id of the cancellation

string

Example

0cc46bf7-61dc-4abc-a527-f637d2d1fc76

endToEndId

The end to end ID from PIX

string

Example

E33630661202501190000000000001

idempotencyKey

required

The idempotency key

string

Example

6edbd94a-8ad5-48c2-961a-27250853e9c0

status

required

The cancellation status

string

Allowed values: INITIAL PENDING ACCEPTED REJECTED ERROR

Example

ACCEPTED

statusHistory

required

The array of status history

Array<object>

object

status

required

The status

string

Allowed values: INITIAL PENDING ACCEPTED REJECTED ERROR

Example

PENDING

createdAt

required

The date and time when the resource was created, in ISO 8601 format (RFC 3339), UTC. Example: 2025-01-15T10:00:00Z

string

Example

2025-01-15T10:00:00Z

reason

required

The reason of the cancellation

string

Allowed values: ACCOUNT_CLOSURE ACCOUNT_BLOCKED AUTHORIZATION_CANCELED SETTLEMENT_ERROR OTHER_REASONS REQUESTED_BY_PAYER REQUESTED_BY_RECEIVER

Example

REQUESTED_BY_RECEIVER

customer

required

The customer object that requested the cancellation

object

document

required

The customer document

object

type

required

Document type

string

Allowed values: CPF CNPJ

Example

CPF

number

required

Document number

string

Example

12345678910

createdAt

required

The date and time when the resource was created, in ISO 8601 format (RFC 3339), UTC. Example: 2025-01-15T10:00:00Z

string

Example

2025-01-15T10:00:00Z

updatedAt

The date and time when the resource was last updated, in ISO 8601 format (RFC 3339), UTC. Example: 2025-01-20T14:45:00Z

string

Example

2025-01-20T14:45:00Z

400

object

error

string

Example

INVALID_REQUEST

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

403

object

error

string

Example

FORBIDDEN_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

404

Resource not found

object

error

string

Example

NOT_FOUND

message

string

Example

Resource not found

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]