Developer Zone
These docs are for v4.0.2. Click to read the latest docs for v4.3.0.

Store Card 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

 

Add Card Request Parameters

<MaintenanceRequest>
	<version>2.3</version>
	<timeStamp></timeStamp>
	<merchantID></merchantID>
	<storeCardUniqueID></storeCardUniqueID>
	<pan></pan>
	<panBank></panBank>
	<panCountry></panCountry>
	<panCurrency></panCurrency>
	<cardholderName></cardholderName>
	<cardholderEmail></cardholderEmail>
	<panExpiry></panExpiry>
	<action>A</action>
</MaintenanceRequest>

Parameter

Data Type / Length

Mandatory

Description

Version

C 5

M

Request version number

Current : 2.3

timeStamp

C 22

O

Request time stamp

  • In ddMMyyHHmmss format

merchantID

C 15

M

Merchant ID

panBank

C 50

O

Card Issuer bank name

panCountry

C 2

O

Card Issuer bank country code

  • Uses ISO3166-1 alpha 2 codes

cardholderName

C 50

M

Cardholder name

cardholderEmail

C 50

O

Cardholder email address

panExpiry

C 4

M

Card expiry date

  • In MMYY format

pan

C 19

M

Full card number

panCurrency

C 3

O

Card primary currency code

Refer to: Currency Code List

action

C 1

M

Maintenance action command

  • A = Add

 

Update Card Request Parameters

<MaintenanceRequest>
	<version>2.3</version>
	<timeStamp></timeStamp>
	<merchantID></merchantID>
	<storeCardUniqueID></storeCardUniqueID>
	<pan></pan>
	<panBank></panBank>
	<panCountry></panCountry>
	<panCurrency></panCurrency>
	<cardholderName></cardholderName>
	<cardholderEmail></cardholderEmail>
	<panExpiry></panExpiry>
	<action>U</action>
</MaintenanceRequest>

Parameter

Data Type / Length

Mandatory

Description

Version

C 5

M

Request version number

Current : 2.3

timeStamp

C 22

O

Request time stamp

  • In ddMMyyHHmmss format

merchantID

C 15

M

Merchant ID

storeCardUniqueID

C 20

M

Unique ID provided by 2C2P

panBank

C 50

O

Card Issuer bank name

panCountry

C 2

O

Card Issuer bank country code

  • Uses ISO3166-1 alpha 2 codes

cardholderName

C 50

M

Cardholder name

cardholderEmail

C 50

O

Cardholder email address

panExpiry

C 4

M

Card expiry date

  • In MMYY format

pan

C 19

M

Full card number

panCurrency

C 3

O

Card primary currency code

Refer to: Currency Code List

action

C 1

M

Maintenance action command

  • U = Update

 

Delete Card Request Parameter

<MaintenanceRequest>
	<version>2.3</version>
	<timeStamp></timeStamp>
	<merchantID></merchantID>
	<storeCardUniqueID></storeCardUniqueID>
	<pan></pan>
	<panBank></panBank>
	<panCountry></panCountry>
	<panCurrency></panCurrency>
	<cardholderName></cardholderName>
	<cardholderEmail></cardholderEmail>
	<panExpiry></panExpiry>
	<action>D</action>
</MaintenanceRequest>

Parameter

Data Type / Length

Mandatory

Description

Version

C 5

M

Request version number

Current : 2.3

timeStamp

C 22

O

Date and time of the
maintenance request.

format of
"ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

storeCardUniqueID

C 20

M

Unique ID provided by 2C2P

panBank

C 50

O

Card Issuer bank name

panCountry

C 2

O

Card Issuer bank country code

  • Uses ISO3166-1 alpha 2 codes

cardholderName

C 50

M

Cardholder name

cardholderEmail

C 50

O

Cardholder email address

panExpiry

C 4

O

Card expiry date

  • In MMYY format

pan

C 19

O

Full card number

panCurrency

C 3

O

Card primary currency code

Refer to: Currency Code List

action

C 1

M

Maintenance action command

  • D = Delete

 

Inquiry Card Info Request Parameters

<MaintenanceRequest>
	<version>2.3</version>
	<timeStamp></timeStamp>
	<merchantID></merchantID>
	<storeCardUniqueID></storeCardUniqueID>
	<action>I</action>
</MaintenanceRequest>

Parameter

Data Type / Length

Mandatory

Description

Version

C 5

M

Request version number

Current: 2.3

timeStamp

C 22

O

Request time stamp

  • In ddMMyyHHmmss format

merchantID

C 15

M

Merchant ID

storeCardUniqueID

C 20

M

Unique ID provided by 2C2P

panBank

C 50

O

Card Issuer bank name

panCountry

C 2

O

Card Issuer bank country code

  • Uses ISO3166-1 alpha 2 codes

cardholderName

C 50

O

Cardholder name

cardholderEmail

C 50

O

Cardholder email address

panExpiry

C 4

O

Card expiry date

  • In MMYY format

pan

C 19

O

Full card number

panCurrency

C 3

O

Card primary currency code

Refer to: Currency Code List

action

C 1

M

Maintenance action command

  • I = Inquiry

 

Card Response Parameters

<MaintenanceResponse>
	<version>2.3</version>
	<timeStamp></timeStamp>
	<merchantID></merchantID>
	<respCode></respCode>
	<respReason></respReason>
	<panBank></panBank>
	<storeCardUniqueID></storeCardUniqueID>
	<panCountry></panCountry>
	<cardholderName></cardholderName>
	<cardholderEmail></cardholderEmail>
	<panMasked></panMasked>
</MaintenanceResponse>

Parameter

Data Type / Length

Mandatory

Description

Version

C 5

M

Request version number

timeStamp

C 22

O

Request time stamp

  • In ddMMyyHHmmss format

merchantID

C 15

M

Merchant ID

respCode

C 2

M

00 = Success

  • Any RespCode that is not 00 indicates failure

respReason

C 100

M

Reason of failure

panBank

C 50

O

Card Issuer bank name

storeCardUniqueID

C 20

M

Unique ID provided by 2C2P

panCountry

C 2

O

Card Issuer bank country code

  • Uses ISO3166-1 alpha 2 codes

cardholderName

C 50

M

Cardholder name

cardholderEmail

C 50

O

Cardholder email address

panMasked

C 19

M

Masked Card Format

  • Based on 2C2P merchant profile settings

• First 6 Last 4 (411111XXXXXX1111)
• Last 4 (XXXXXXXXXXXX1111)

Updated almost 2 years ago