Recurring Information

The following examples are an overview on how to send recurring data.
The code shown is intended to give you a start point on how to implement recurring information in our services.

Pay attention: recurring series is limited in time. The maximum duration is 10 years.

Each recurring field has the following format:
{number of charges}{gap unit}{gap length}A{amount}

Recurring Field Part Description Possible Values
{number of charges} A number of charges in this stage of the recurring series A positive integer number between 1 and 99
{gap unit} A unit to specify a gap between the dates of subsequent charges D (day), W (week), M (month), Q (quarter), Y (year)
{gap length} A number of gap units 1 or more
A{amount} Amount to charge every time (optional) with decimal point (if needed) Use only if the amount to charge at this stage is different from the initial transaction amount. If the amount is omitted, letter A must be omitted, too.

Recurring Server to Server

See Recurring information for detailed description and for some useful examples. Pay attention: recurring series is limited in time. The maximum duration is 10 years.

RecurringTransType Specifies transaction type for subsequent transactions. Does not affect the initial transaction. Accepts the same values as TransType. If omitted, all the subsequent transactions will be of the same type as the initial transaction. 1 Optional
Recurring1 Parameter for first stage in the recurring series 12 Optional
Recurring2 Parameter for second stage in the recurring series 12 Optional
Recurring3 Parameter for third stage in the recurring series 12 Optional
Recurring4 Parameter for fourth stage in the recurring series 12 Optional
Recurring5 Parameter for fifth stage in the recurring series 12 Optional
Recurring6 Parameter for sixth stage in the recurring series 12 Optional

Recurring Value Generator

Use the below logic to generate the recurring value

Charge the client a total of charges, every

Examples

Recurring1=12M1
Annual subscription with monthly charges, $10 each charge
Total amount is $120 for a year

Recurring1=4Q1
Annual subscription with quarterly charges, $10 each charge
Total amount is $40 for a year

Recurring1=1D5&Recurring2=12M1A30
5 days trial, then annual subscription with monthly charges, $30 each charge
Total amount is $370 for a year and five days

Recurring1=1D5&Recurring2=1D25A20&Recurring3=11M1A30
5 days trial, then a "remainder" charge ($20 for 25 days), then 11 months subscription with monthly charges, $30 each payment
Total amount is $360 for a year

Recurring1=3M1&Recurring2=3M1A20&Recurring3=6M1A30
Annual subscription: first three months for $10 a month, then three months for $20 a month, then 6 months for $30 a month
Total amount is $270 for a year

Recurring1=1M1&Recurring2=2M1A10&Recurring3=3M1A20&Recurring4=6M1A30&RecurringTransType=0
Annual subscription: first month for free, then two months for $10 a month, then three months for $20 a month, then 6 months for $30 a month Total amount is $260 for a year.

Important for this sample
- TransType must be 1, this ensures first month for free.
- Amount should be 1, in order to affect the payment ability of the credit card as less as possible.

Manage Recurring Series - Submitting Data

This page describes how to remotely edit/cancel an existing recurring series.
Using this interface you can:

  • suspend active series
  • resume suspended series
  • modify dates and/or amounts of future charges
  • delete series
The request must be sent from your server to the following URL:https://process.coriunder.cloud/member/recurring_modify.aspx
Code Example
https://process.coriunder.cloud/member/recurring_modify.aspx?MerchantNumber=5722306&SeriesID=123&Action=SUSPEND
                        
Code Example
>https://process.coriunder.cloud/member/recurring_modify.aspx?MerchantNumber=5722306&TransID=987654&Action=RESUME
                        
Code Example
https://process.coriunder.cloud/member/recurring_modify.aspx?MerchantNumber=5722306&SeriesID=123&Action=MODIFY&StartDD=15&StartMM=07&StartYYYY=2009&Recurring1=1W2A5.99&Recurring2=11M1A9.99
                        

Request Fields

Field Required Description
MerchantNumber Yes Your merchant number - 5722306
SeriesID Yes1 ID number of the recurring series.This field is required only if TransID is omitted.
TransID Yes1 ID number of the initial transaction that started the recurring series.This field is required only if SeriesID is omitted.
Action Yes Action to take on the series. Accepts one of the following values:
  • SUSPEND - Suspend the specified series, if active
  • RESUME - Resume the specified series, if suspended
  • DELETE - Delete the specified series (this cannot be undone!)
  • MODIFY - Drop all the future charges and create new charges based on the Recurring fields
Uncharged No When resuming the series (Action=RESUME), action to take on the past charges which are still unprocessed. Accepts one of the following values:
  • CANCEL - Cancel all past charges which are still unprocessed.
  • REINSTATE - Reinstate all past charges which are still unprocessed (also charges that were manually canceled in the past).
  • Empty (or omitted) – No changes are made to charges' state.
Signature No Signature for verifying the authenticity of the request parameters. Field values to use: MerchantNumber + SeriesID + TransID + Action + PersonalHashKey Refer to for detailed explanation.

Optional Fields - Start Date

When the action is MODIFY, all the future charges in the specified recurring series are deleted. You can specify a date to start new charges' schedule. If omitted, the first of the new charges will be scheduled for today. If the first of the new charges is scheduled for today, it will be processed immediately!

Field Length Description Details
StartDD 2 Day Day to start the future charges. Between 1 and 31, depending on month specified in StartMM.
StartMM 2 Month Month to start the future charges. Between 1 and 12.
StartYYYY 4 Year Year to start the future charges. Cannot be less than the current year.

Optional Fields - Recurring Strings

When the action is MODIFY, new payment schedule must be set. See for the recurring string structure and examples. Pay attention: recurring series is limited in time. The maximum duration is 10 years.

Field Description MaxLength Required 2
Recurring1 Parameter for first stage in the recurring series 12 Yes
Recurring2 Parameter for second stage in the recurring series 12 No
Recurring3 Parameter for third stage in the recurring series 12 No
Recurring4 Parameter for fourth stage in the recurring series 12 No
Recurring5 Parameter for fifth stage in the recurring series 12 No
Recurring6 Parameter for sixth stage in the recurring series 12 No

(1) Either SeriesID or TransID must be provided
(2) When the action is MODIFY

Manage Recurring - Checking Reply

After the recurring series management request is received and processed, CoriunderCloud system returns the reply code.
This reply is for only the recurring management.
To receive notification when recurring transaction is processed use the following setting page

Example to how and what is replied

Field
Description
Reply
Two digits reply code (possible codes are listed below).
Description
The textual representation of the reply code (from the list below)
Details
Additional information, that may be useful for debugging purposes.
Usually contains a list of fields with invalid values.
Code Example
REPLY=00&DESCRIPTION=SUCCESS
                        
Code Example
REPLY=09&DESCRIPTION=INVALID RECURRING STRING&DETAILS=Recurring2 5N1A7.01
                        

Reply Codes

Reply codes

00 = SUCCESS
01 = MISSING ACTION
02 = INVALID ACTION
03 = MISSING MERCHANT NUMBER
04 = SERIES ID CONFLICTS WITH TRANSACTION ID
05 = MISSING SERIES ID OR TRANSACTION ID
06 = MERCHANT NOT FOUND OR NOT AUTHORIZED
07 = SERIES NOT FOUND FOR THE MERCHANT
08 = MISSING RECURRING1
09 = INVALID RECURRING STRING
10 = INVALID START DATE
11 = START DATE IS IN THE PAST
12 = SERIES BLOCKED
13 = INVALID UNCHARGED
14 = INVALID SIGNATURE