Guides
API Reference
Start typing to search…

Create a Recurring Debit or Credit.

post https://stage.check21.com/c2/api/recurring

The POST Recurring Endpoint is utilized by a client who chooses to allow Check21.com to manage recurring record. By doing so, a credit to a customer or debit of a customer can be automated. Please note that a Recurring Record is not a transaction but is used as a method in automation the transaction creation process within a specific timeframe.

Log in to see full request history
Body Params
int32
required

Recurring transactions require a Customer Account ID to be created prior to submission of a Recurring record. Please use the Customer Account ID value received during the Customer-Account Endpoint usage.

int32

Determines the Client Bank Account which will be used for deposit when a transaction is created. Deposit Bank Account ID is provided by Check21.com.

int32

Determines the Client Bank Account which will be used for credit when a transaction is created. Credit Bank Account ID is provided by Check21.com.

date
required

This field determines when the first recurring transaction will be created by Check21.com.

double
required

The amount which will be utilized for the first recurring transaction created by Check21.com

string

This field is only used if the Client does not utilize the recurOnXofMonth or recurEveryXDays fields. It is used to determine the date which all subsequent transactions are created (all transactions but the initial/first transaction) If selecting Annual, the customer will be debited or credited on January 1st of each year. If selecting Semi-Annual, the customer will be debited or credited on January 1st and July 1st of each year. If selecting Tri-Annual, the customer will be debited or credited on January 1st, May 1st, and September 1st of each year. If Quarterly is selected, customer will be debited or credited on January 1st, April 1st, June 1st, and October 1st of each year.

number

This field is only used if the Client does not utilize the staticDate or recurEveryXDays fields. It allows the client to determine which day of the month all subsequent transactions should be created (all transaction but the initial/first transaction). Please note, if the month does not include the day selected (i.e. 31 not available in February), the last day of the month (i.e. February 28) will be selected as the transaction date in that billing cycle.

number

This field is only used if the Client does not utilize the staticDate or recurOnXOfMonth fields. It allows the client to determine the number of days from the first bill date and all subsequent dates a transaction should be created (all transaction but the initial/first transaction). For example, every 30 days from the first bill date.

boolean
required

The value of this field determines whether the Customer will be credited or debited twice in the same month. For example, when true, if the first bill date is February 6th and the Client selected recurOnXOfMonth = 20, the customer will be debited or credit on February 6th and February 20th. If the value of this field is false, the customer will be debited or credited on February 6th and March 20th, skipping the first subsequent billing cycle.

double
required

The amount of all subsequent transactions created as part of this recurring record.

int32
required

The number of times, including the initial time, a recurring transaction will be created. For example, if the Client would like to bill its Customer on the 1st of the month for 12 months, the value of this field should be set to 12.

string
string
boolean
required

If marked true, any prior recurring record still in Active status for this client will be marked Inactive, thus voiding all future recurring transactions for the prior record. If marked false, the customer will be credited or debited for all recurring records.

Headers
string
required

application/json should be set.

string
required

Can be found in the administrative user profile within the Check21.com Gateway

string
required

Can be found in the administrative user profile within the Check21.com Gateway

string
required

application/json should be set.

Responses

Updated 12 days ago

Language
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago