Skip to content

Force update a subscription status and receive postback webhook.

PUT
/order-tools/v1/banking/subscription/status
object
id
required

Unique id of the subscription 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: the payer authorized the recurrence. Payer bank data is generated.
- REJECTED: the payer refused the authorization.
- CANCELED: cancellation accepted, the subscription becomes CANCELED.
- CANCELLATION_REJECTED: cancellation refused, the subscription keeps its status.

Final status: REJECTED, CANCELED, ERROR. Subscriptions in a final status
can't be changed.

- PENDING_AUTHORIZATION can be changed to ACCEPTED or REJECTED.
- ACCEPTED can only be changed to CANCELED.

INITIAL, PENDING_AUTHORIZATION and ERROR are not offered: they are not
reported by the JD.
string
Allowed values: ACCEPTED REJECTED CANCELED CANCELLATION_REJECTED

The resource was returned successfully

object
id
required

Subscription id.

string
Example
5f4e3f2b-0b7b-4b7d-8b3d-3b3b7b3b7b3b
description
required

Description of the operation status.

string
Example
Subscription status change to ACCEPTED executed.
Array<string>

An unexpected error occurred inside the server

Array<string>