Recurring Maintenance API

Recurring Inquiry Request Parameter
Recurring Update Request Parameter
Recurring Cancel Request Parameter
Recurring Response Parameter

Ā 

šŸ“˜

Data Attribute Reference

Data Type
A - Alphabet, N - Numeric, AN - AlphaNumeric, C - Characters, D - Decimal, B - Boolean

Mandatory
M - Mandatory, C - Conditional, O - Optional

Ā 

Recurring Inquiry Request Parameter


Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Version of the Recurring
Maintenance Request.

Current : 2.1

timeStamp

C 22

O

Date and time of request Message.

Format "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

recurringUniqueID

N 20

M

The unique id of recurring
payment cycle.

This id is returned by 2C2P to merchant for
recurring payment request.

processType

C 1

M

Payment process command.

I = Inquiry

recurringStatus

C 1

O

The status of recurring
payment cycle.

ā€˜Yā€™ for active.
ā€˜Nā€™ for inactive.

amount

N 12

O

Recurring amount in 12
digits leading zero format.

allowAccumulate

C 1

O

Allow accumulation if
authorization failed.

Indicate allow accumulation in next recurring cycle.

maxAccumulateAmount

N 12

O

Limit for the accumulate
amount before terminate.
Format is 12 digits leading
zero format.

recurringInterval

N 5

O

Recurring Interval in days.

Charge card every x days. Max value 365 (1 year).

recurringCount

N 5

O

Recurring total count allowed.

Repeat this payment x times. Value ā€˜0ā€™ for
endless loop until
terminated manually.

chargeNextDate

C 8

O

The next date of recurring
payment.

Date in DDMMYYYY
format.

Ā 

Recurring Update Request Parameter


Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Version of the Recurring
Maintenance Request.

Current : 2.1

timeStamp

C 22

O

Date and time of request Message.

Format "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

recurringUniqueID

N 20

M

The unique id of recurring
payment cycle.

This id is returned by 2C2P to merchant for
recurring payment request.

processType

C 1

M

Payment process command.

U = Update

recurringStatus

C 1

O

The status of recurring
payment cycle.

set ā€˜Yā€™ for active.
set ā€˜Nā€™ for inactive.

amount

N 12

M

Recurring amount in 12
digits leading zero format.

allowAccumulate

C 1

O

Allow accumulation if
authorization failed.

Indicate allow accumulation in next recurring cycle.

maxAccumulateAmount

N 12

O

Limit for the accumulate
amount before terminate.
Format is 12 digits leading
zero format.

recurringInterval

N 5

M

Recurring Interval in days.

Charge card every x days. Max value 365 (1 year).

recurringCount

N 5

M

Recurring total count allowed.

Repeat this payment x times. Value ā€˜0ā€™ for
endless loop until
terminated manually.

chargeNextDate

C 8

O

The next date of recurring
payment.

Date in DDMMYYYY
format.

Ā 

Recurring Cancel Request Parameter


Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Version of the Recurring
Maintenance Request.

Current : 2.1

timeStamp

C 22

O

Date and time of request Message.

Format "ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

recurringUniqueID

N 20

M

The unique id of recurring
payment cycle.

This id is returned by 2C2P to merchant for
recurring payment request.

processType

C 1

M

Payment process command.

C = Cancel

recurringStatus

C 1

O

The status of recurring
payment cycle.

ā€˜Yā€™ for active.
ā€˜Nā€™ for inactive.

amount

N 12

O

Recurring amount in 12
digits leading zero format.

allowAccumulate

C 1

O

Allow accumulation if
authorization failed.

Indicate allow accumulation in next recurring cycle.

maxAccumulateAmount

N 12

O

Limit for the accumulate
amount before terminate.
Format is 12 digits leading
zero format.

recurringInterval

N 5

O

Recurring Interval in days.

Charge card every x days. Max value 365 (1 year).

recurringCount

N 5

O

Recurring total count allowed.

Repeat this payment x times. Value ā€˜0ā€™ for
endless loop until
terminated manually.

chargeNextDate

C 8

O

The next date of recurring
payment.

Date in DDMMYYYY
format.

Ā 

Recurring Response Parameter


Parameter

Data Type/ Length

Mandatory

Description

version

C 5

M

Version of the Recurring
Maintenance Response.

Current : 2.1

timeStamp

C 22

M

Date and time of request Message.

Format "ddMMyyHHmmss"

respCode

C 3

M

Response Code.

00 = success.

If is not 00 means is failed.

respReason

C 100

O

Reason of Failure

recurringUniqueID

N 20

M

The unique id of
recurring payment
cycle

recurringStatus

C 1

M

The status of recurring
payment cycle.

ā€˜Yā€™ for active.
ā€˜Nā€™ for inactive.

invoicePrefix

C 15

M

Invoice Prefix

currency

N 3

M

Currency Code.

Refer to Currency Code List

amount

N 12

M

Recurring amount
in 12 digits leading
zero format.

maskedCardNo

C 16

M

Masked Credit
Card Number.

Masked Card Format based on merchant profile setting.
ā€¢ First 6 Last 4 (411111XXXXXX1111)
ā€¢ Last 4 (XXXXXXXXXXXX1111)

allowAccumulate

C 1

M

Allow accumulation if
authorization failed.

Indicate allow accumulation in next recurring cycle.

maxAccumulateAmount

N 12

M

Limit for the accumulate
amount before terminate.
Format is 12 digits leading
zero format.

recurringInterval

N 5

M

Recurring Interval in days.

Charge card every x days. Max value 365 (1 year).

recurringCount

N 5

M

Recurring total count allowed.

Repeat this payment x times. Value ā€˜0ā€™ for
endless loop until
terminated manually.

currentCount

N 5

O

Current recurring count of recurring cycle.

chargeNextDate

C 8

O

The next date of recurring
payment.

Date in DDMMYYYY
format.