Skip to main content

Search Stored Cards

URL

The endpoint and http method information to inquiry stored cards are stated below.

GET/payment/v1/cards

Request Parameters

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

cardAlias
string

Name / Alias of the card

cardBrand
string

Brand of the card

cardType
string

Type of the card

cardUserKey
string

User key value generated for the card

cardToken
string

Token value generated for the card

cardBankName
string

Name of the card bank

cardAssociation
string

Card association

cardExpiryStatus
CardExpiryStatus

Card expiry status

Values:
EXPIRED
WILL_EXPIRE_NEXT_MONTH
NOT_EXPIRED
minCreatedDate
date

Minimum stored card create date to filter cards

maxCreatedDate
date

Maximum stored card create date to filter cards

page
number

Page count for pagination

size
number

Page size for pagination

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

cardToken
string

Token value

cardAlias
string

Name / Alias of the card

cardHolderName
string

Cardholder name

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
createdAt
string

Stored card creation date

Sample Codes

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

Loading..