Scheduling API

With Scheduling API, you can schedule DB, PA or CD transaction in the future.

How it works

1. Store the payment data

Register the customer payment information could be done from COPYandPAY or could be done through Server-To-Server in two methods: Store the data during a payment or store it as stand alone.

As per PSD2 standard, all subsequent transactions done by merchant on behalf of shopper while he is not present (MIT) should contain initial transaction ID - link between initial payment made while customer is present and all subsequent ones. Hence, if customer payment information has been stored as standalone, an initial payment should be performed while shopper is present. The Using the stored payment data tutorial explains this scenario.

Following is an example of storing credit card data during a payment.

2. Schedule a payment

Send a request to /schedules endpoint with the registrationId, payment type and the job schedule which describes when and how often the transaction should be committed. standingInstruction.type RECURRING or INSTALLMENT may be also specified

For complete reference of job parameters, check API Parameters Reference:

3. We execute the transaction for you

As the scheduled transaction triggers, the system commits the payment transaction on time using the stored payment information and payment type specified.

The system will commit a payment transaction with the paymentType, amount and currency specified, and will use the payment information registered on the first step.

4. Cancel the schedule

As the case of canceling the scheduled transaction, merchant sends a deschedule request to cancel future transactions.

Send a de-scheduling request specifying the schedule id you want to cancel: