Force update a scheduled payment status and receive postback webhook.
PUT /order-tools/v1/banking/subscription/payments/status
PUT
/order-tools/v1/banking/subscription/payments/status
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”object
id
required
Unique id of the scheduled payment in the order service.
string
Example
5f4e3f2b-0b7b-4b7d-8b3d-3b3b7b3b7b3b status
required
The scenario you want to simulate. Everything else the JD callback needs is
filled in by this API.
- ACCEPTED, COMPLETED, REJECTED, CANCELED, CANCELED_INSUFFICIENT_BALANCE:
plain status callbacks.
- ERROR: status callback carrying a generated error code.
- CANCELED_SETTLEMENT_ERROR: cancelled because settlement failed. This is the
one that makes the order worker automatically reschedule the payment — only
on its own due date, before 21:00 BRT, up to 3 times.
- CANCELLATION_PENDING: cancellation accepted but not processed, the payment
keeps its status.
- CANCELLATION_REJECTED: cancellation refused, the payment keeps its status.
Final status: REJECTED, COMPLETED, ERROR, CANCELED,
CANCELED_INSUFFICIENT_BALANCE. Scheduled payments in a final status can't be
changed.
- PENDING can be changed to ACCEPTED, REJECTED, ERROR or CANCELED.
- ACCEPTED can be changed to COMPLETED, ERROR, CANCELED or
CANCELED_INSUFFICIENT_BALANCE.
INITIAL and PENDING are not offered: they are set by the order service when
the payment is scheduled.string
Responses
Section titled “ Responses ”The resource was returned successfully
object
id
required
Scheduled payment id.
string
Example
5f4e3f2b-0b7b-4b7d-8b3d-3b3b7b3b7b3b description
required
Description of the operation status.
string
Example
Scheduled payment status change to COMPLETED executed.Array<string>
An unexpected error occurred inside the server
Array<string>