Recurring Maintenance API

πŸ“˜

Data Attribute Reference

Data Type

  • A: Alphabet
  • AN: Alphanumeric
  • C: Characters
  • B: Boolean
  • D: Decimal
  • N: Numeric

Mandatory attributes

  • M: Mandatory
  • C: Conditional
  • O: Optional

Β 

Recurring Inquiry Request Parameters


<RecurringMaintenanceRequest>
   <version>2.1</version>
   <timeStamp></timeStamp>
   <merchantID></merchantID>
   <recurringUniqueID></recurringUniqueID>
   <processType>I</processType>
   <recurringStatus></recurringStatus>
   <amount></amount>
   <allowAccumulate></allowAccumulate>
   <maxAccumulateAmount></maxAccumulateAmount>
   <recurringInterval></recurringInterval>
   <recurringCount></recurringCount>
   <chargeNextDate></chargeNextDate>
</RecurringMaintenanceRequest>

Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Request version number

Current: 2.1

timeStamp

C 22

O

Request time stamp

  • In ddMMyyHHmmss format

merchantID

C 15

M

Merchant ID

recurringUniqueID

N 20

M

Unique ID of recurring
payment cycle

  • Returned by 2C2P to merchant for recurring payment request

processType

C 1

M

Payment process command

  • I = Inquiry

recurringStatus

C 1

O

Status of the recurring
payment cycle

  • Y: active
  • N: inactive

amount

N 12

O

Recurring amount

  • In 12-digit leading zero format

allowAccumulate

C 1

O

Allow accumulation if
authorization failed

  • If enabled, allows accumulation of failed transaction amounts in next recurring cycle

maxAccumulateAmount

N 12

O

Limit for total amount of failed transactions that can accumulate before terminating the cycle

  • In 12-digit 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

Count of recurring transactions allowed

  • Repeat this payment x times
  • Set to β€˜0’ for continuous recurring transactions until terminated manually

chargeNextDate

C 8

O

Next date of recurring
payment

  • In DDMMYYYY
    format

Β 

Recurring Update Request Parameters


<RecurringMaintenanceRequest>
   <version>2.1</version>
   <timeStamp></timeStamp>
   <merchantID></merchantID>
   <recurringUniqueID></recurringUniqueID>
   <processType>U</processType>
   <recurringStatus></recurringStatus>
   <amount></amount>
   <allowAccumulate></allowAccumulate>
   <maxAccumulateAmount></maxAccumulateAmount>
   <recurringInterval></recurringInterval>
   <recurringCount></recurringCount>
   <chargeNextDate></chargeNextDate>
</RecurringMaintenanceRequest>

Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Request version number

Current : 2.1

timeStamp

C 22

O

Request time stamp

  • In ddMMyyHHmmss format

merchantID

C 15

M

Merchant ID

recurringUniqueID

N 20

M

Unique ID of recurring
payment cycle

  • Returned by 2C2P to merchant for recurring payment request

processType

C 1

M

Payment process command

  • U = Update

recurringStatus

C 1

O

Status of the recurring
payment cycle

  • Y: active
  • N: inactive

amount

N 12

M

Recurring amount

  • In 12-digit leading zero format

allowAccumulate

C 1

O

Allow accumulation if
authorization failed

  • If enabled, allows accumulation of failed transaction amounts in next recurring cycle

maxAccumulateAmount

N 12

O

Limit for total amount of failed transactions that can accumulate before terminating the cycle

  • In 12-digit 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

Count of recurring transactions allowed

  • Repeat this payment x times
  • Set to β€˜0’ for continuous recurring transactions until terminated manually

chargeNextDate

C 8

O

Next date of recurring
payment

  • In DDMMYYYY
    format

Β 

Recurring Cancel Request Parameters


<RecurringMaintenanceRequest>
   <version>2.1</version>
   <timeStamp></timeStamp>
   <merchantID></merchantID>
   <recurringUniqueID></recurringUniqueID>
   <processType>C</processType>
   <recurringStatus></recurringStatus>
   <amount></amount>
   <allowAccumulate></allowAccumulate>
   <maxAccumulateAmount></maxAccumulateAmount>
   <recurringInterval></recurringInterval>
   <recurringCount></recurringCount>
   <chargeNextDate></chargeNextDate>
</RecurringMaintenanceRequest>

Parameter

Data Type/ Length

Mandatory

Description

version

AN 5

M

Request version number

Current: 2.1

timeStamp

C 22

O

Request time stamp

  • In ddMMyyHHmmss format

merchantID

C 15

M

Merchant ID

recurringUniqueID

N 20

M

Unique ID of recurring
payment cycle

  • Returned by 2C2P to merchant for recurring payment request

processType

C 1

M

Payment process command

  • C = Cancel

recurringStatus

C 1

O

Status of the recurring
payment cycle

  • Y: active
  • N: inactive

amount

N 12

O

Recurring amount

  • In 12-digit leading zero format

allowAccumulate

C 1

O

Allow accumulation if
authorization failed

  • If enabled, allows accumulation of failed transaction amounts in next recurring cycle

maxAccumulateAmount

N 12

O

Limit for total amount of failed transactions that can accumulate before terminating the cycle

  • In 12-digit 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

Count of recurring transactions allowed

  • Repeat this payment x times
  • Set to β€˜0’ for continuous recurring transactions until terminated manually

chargeNextDate

C 8

O

Next date of recurring
payment

  • In DDMMYYYY
    format

Β 

Recurring Response Parameters


<RecurringMaintenanceResponse>
    <version></version>
    <timeStamp></timeStamp>
    <respCode></respCode>
    <respReason></respReason>
    <recurringUniqueID></recurringUniqueID>
    <recurringStatus></recurringStatus>
    <invoicePrefix></invoicePrefix>
    <currency></currency>
    <amount></amount>
    <maskedCardNo></maskedCardNo>
    <allowAccumulate></allowAccumulate>
    <maxAccumulateAmount></maxAccumulateAmount>
    <recurringInterval></recurringInterval>
    <recurringCount></recurringCount>
    <currentCount></currentCount>
    <chargeNextDate></chargeNextDate>
</RecurringMaintenanceResponse>

Parameter

Data Type/ Length

Mandatory

Description

version

C 5

M

Request version number

Current: 2.1

timeStamp

C 22

M

Request time stamp

  • In ddMMyyHHmmss format

respCode

C 3

M

Response Code

  • 00 = success
  • If not 00, the process has failed

respReason

C 100

O

Reason of Failure

recurringUniqueID

N 20

M

Unique ID of recurring
payment cycle

  • Returned by 2C2P to merchant for recurring payment request

recurringStatus

C 1

M

Status of the recurring
payment cycle

  • Y: active
  • N: 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-digit 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

  • If enabled, allows accumulation of failed transaction amounts in next recurring cycle

maxAccumulateAmount

N 12

M

Limit for total amount of failed transactions that can accumulate before terminating the cycle

  • In 12-digit 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

Count of recurring transactions allowed

  • Repeat this payment x times
  • Set to β€˜0’ for continuous recurring transactions until terminated manually

currentCount

N 5

O

Current count of transactions for recurring cycle

chargeNextDate

C 8

O

Next date of recurring
payment

  • In DDMMYYYY
    format