Skip to main content

Store Card

URL

The endpoint and http method information to store card independently are stated below.

POST/payment/v1/cards

Request Parameters

The parameters expected to be sent in the requests to be made for card storage are listed under the table and sub-headings below.

cardHolderName
string
required

Cardholder name
We do not allow the following characters: <>"%;&+()|=! and more than five numeric characters.

cardNumber
string
required

Card Number

expireYear
string
required

Expiry Year of the card

expireMonth
string
required

Expiry Month of the card

cardAlias
string

Name - Alias of the card

cardUserKey
string

User key that generated before for the card

Response Parameters

binNumber
string

First 8 digit of the card number

lastFourDigits
string

Last 4 digit of the card number

cardUserKey
string

User key value that generated after successful card storage. It should be stored by the merchant by associating it with the customer.

cardToken
string

Token value that generated after successful card storage. It should be stored by the merchant by associating it with the customer.

cardAlias
string

Name / Alias of the card

cardType
CardType

Card Type

Values:
CREDIT_CARD
DEBIT_CARD
PREPAID_CARD
cardAssociation
CardAssociation

Card association

Values:
VISA
MASTER_CARD
AMEX
TROY
JCB
UNION_PAY
MAESTRO
DISCOVER
DINERS_CLUB
cardBrand
string

Brand of the card

cardBankName
string

Name of the card bank

cardBankId
number

ID value of the card bank

cardExpiryStatus
CardExpiryStatus

Card expiry status.

Values:
EXPIRED
WILL_EXPIRE_NEXT_MONTH
NOT_EXPIRED

Sample Codes

You can review the sample codes in the open source Craftgate API clients.

Loading..