Developer ZoneRecipesAPI ReferenceChangelog
Developer Zone

Customer Token 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 Customer Request Parameters


{
    "merchantID": "",
    "accountNo": "",
    "name": "",
    "email": "",
    "expiry": "",
    "accountIssuer": "",
    "accountIssuerCountry": "",
    "accountCurrency": "",
    "tokenProvider": ""
}

Parameter

Data Type / Length

Mandatory

Description

merchantID

AN 15

M

merchant ID Provided by 2C2P to merchant.

accountNo

AN 255

O

FULL Card Number / External Token

tokenProvider

C 15

M

Token Provider
For "Add via Token" only

CC - Card
MA - MasterCard Token

name

C 50

C

Cardholder Name

email

C 50

O

Cardholder Email address

expiry

N 6

C

Account Token Expiry
Token Expiry in yyyy-MM-dd format (e.g 2012-02-01)
For Credit Card, expiry day will be last day of the month.

accountIssuer

C 50

O

Account Issuer Bank name.

accountIssuerCountry

C 2

O

Credit Card Issuer Bank Country Code

accountCurrency

C 3

O

Credit Card Primary Currency Code

Add Customer Response Parameters


{
    "responseCode": "",
    "responseDesc": "",
    "merchantID": "",
    "token": "",
    "tokenReference": "",
    "accountNo":"",
    "name": "",
    "email": "",
    "expiry": "",
    "accountIssuer": "",
    "accountIssuerCountry": "",
    "accountCurrency": "",
    "channelCode": "",
    "subChannelCode": ""
}

Parameter

Data Type / Length

Mandatory

Description

responseCode

N 4

M

Response Code

Refer to response code list.

responseDesc

AN 50

M

Response Description

merchantID

AN 15

M

Merchant ID provided by 2C2P

token

AN 255

O

Customer Token

tokenReference

AN 255

O

Optional Customer Token reference

accountNo

AN 255

O

Masked Account No

name

C 50

O

Cardholder Name

email

C 50

O

Cardholder Email address

expiry

N 6

O

Account Token Expiry
Token Expiry in yyyy-MM-dd format (e.g 2012-02-01)
For Credit Card, expiry day will be last day of the month.

subChannelCode

AN 15

O

Channel Code

accountIssuer

C 50

O

Account Issuer name.

accountIssuerCountry

C 2

O

Account Issuer country

accountCurrency

C 3

O

Account Currency Code

Update Customer Token Request Parameters


{
    "merchantID": "",
    "token": "",
    "name": "",
    "email": "",
    "expiry": "",
    "accountIssuer": "",
    "accountIssuerCountry": "",
    "accountCurrency": ""
}

Parameter

Data Type / Length

Mandatory

Description

merchantID

AN 15

M

Merchant ID provided by 2C2P

token

AN 255

M

Customer Token

name

C 50

M

Cardholder Name

email

C 50

O

Cardholder Email address

expiry

N 6

M

Account Token Expiry
Token Expiry in yyyy-MM-dd format (e.g 2012-02-01)
For Credit Card, expiry day will be last day of the month.

accountIssuer

C 50

O

Account Issuer name

accountIssuerCountry

C 2

O

Account Issuer Country Code

accountCurrency

C 3

O

Account Currency Code

Update Customer Token Response Parameters


{
    "responseCode": "",
    "responseDesc": "",
    "merchantID": "",
    "token": "",
    "name": "",
    "email": "",
    "expiry": "",
    "accountIssuer": "",
    "accountIssuerCountry": "",
    "accountCurrency": "",
    "channelCode": "",
    "subChannelCode": ""
}

Parameter

Data Type / Length

Mandatory

Description

responseCode

N 4

M

Response Code

Refer to response code list.

responseDesc

AN 50

M

Response Description

merchantID

AN 15

M

Merchant ID provided by 2C2P

token

AN 255

O

Customer Token

tokenReference

AN 255

O

Optional Customer Token reference

accountNo

AN 255

O

Masked Account No

name

C 50

O

Cardholder Name

email

C 50

O

Cardholder Email address

expiry

N 6

O

Account Token Expiry

  • Token Expiry in yyyy-MM-dd format (e.g 2012-02-01)

channelCode

AN 15

C

Channel Code

subChannelCode

AN 15

O

Sub Channel Code if applicable

accountIssuer

C 50

O

Account Issuer name

accountIssuerCountry

C 2

O

Account Issuer country

accountCurrency

C 3

O

Account Currency Code

Delete Customer Token Request Parameter


{
    "merchantID": "",
    "token": ""
}
ParameterData Type / LengthMandatoryDescription
merchantIDAN 15MMerchant ID provided by 2C2P
tokenAN 255CCustomer Token

Delete Customer Token Response Parameter


{
    "responseCode": "",
    "responseDesc": "",
    "merchantID": "",
    "token": ""
}

Parameter

Data Type / Length

Mandatory

Description

responseCode

N 4

M

Response code

Refer to response code list.

responseDesc

AN 50

M

Response description

merchantID

AN 15

C

Merchant ID provided by 2C2P

token

AN 255

O

Customer Token

Inquiry Customer Token Request Parameter


{
    "merchantID": "",
    "token": ""
}
ParameterData Type / LengthMandatoryDescription
merchantIDAN 15MMerchant ID provided by 2C2P
tokenAN 255CCustomer Token

Inquiry Customer Token Response Parameters


{
    "responseCode": "",
    "responseDesc": "",
    "merchantID": "",
    "token": "",
    "name": "",
    "email": "",
    "expiry": "",
    "accountIssuer": "",
    "accountIssuerCountry": "",
    "accountCurrency": "",
    "channelCode": "",
    "subChannelCode": ""
}

Parameter

Data Type / Length

Mandatory

Description

responseCode

N 4

M

Response Code

Refer to response code list.

responseDesc

AN 50

M

Response Description

merchantID

AN 15

M

Merchant ID provided by 2C2P

token

AN 255

O

Customer Token

name

C 50

O

Cardholder Name

email

C 50

O

Cardholder Email address

expiry

N 6

O

Account Token Expiry

  • Token Expiry in yyyy-MM-dd format (e.g 2012-02-01)

channelCode

AN 15

C

Channel Code

subChannelCode

AN 15

O

Sub Channel Code if applicable

accountIssuer

C 50

O

Account Issuer name

accountIssuerCountry

C 2

O

Account Issuer country

accountCurrency

C 3

O

Account Currency Code