Scheduling Guide

Scheduling API

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

NOTE: You should be fully PCI compliant if you wish to perform tokenization requests server-to-server (as it requires that you collect the card data).

How it works

Store the payment data

Register the customer payment information.

Schedule a payment

Send a schedule request on top of the registration

We execute the transaction for you

Payment transaction committed on time.

Cancel the schedule

Merchant cancels the scheduled transaction.


1. Store the payment data

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

Following is an example of stand alone registration.

2. Schedule a payment

Send a request to /schedules end point with the registrationId, payment type and the job schedule which describes when and how often the transaction should be committed.

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 request to the de-scheduling specifying the referenceId of the scheduled transaction as following: