Back to Index

GET v1/CreditCards/{token}?languageCode={languageCode}

Gets the sanitized details of a stored credit card

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

The token associated with the stored credit card.

string

Required

languageCode

Determines the Language of the response data. 2 Character ISO LanguageCode. Default is 'en'.

string

Required

version

string

None.

Body Parameters

None.

Response Information

Resource Description

credit_card_detail_response
NameDescriptionTypeAdditional information
credit_card_token

The credit_card_token assigned to the credit card

string

None.

order_number

Order number used when one is not provided

string

String length: inclusive between 0 and 50

name_on_card

The name of the card owner as it appears on the credit card

string

String length: inclusive between 2 and 26

card_type

The type of card (brand)

string

None.

masked_card_number

The credit card number as it appears on the card (masked)

string

None.

expiry_month

The credit card expiration month in two-digit format (e.g. 09 for September)

string

String length: inclusive between 2 and 2

expiry_year

The credit card expiration year in two-digit format (e.g. 08 for 2008)

string

String length: inclusive between 2 and 2

billing_name

The primary billing contact name

string

None.

billing_email

The email address for the primary billing contact

string

None.

billing_phone

The phone number for the primary billing contact

string

None.

billing_address

Address for the primary billing contact

address

None.

references

Additional information to record with the credit card request

Collection of reference

None.

success

True if successful, false otherwise

boolean

None.

message

The message related to the operation in the language specified by the request

string

None.

message_code

The code associated with the message

integer

None.

errors

List of validation errors that occured, otherwise empty

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "credit_card_token": "sample string 1",
  "order_number": "sample string 2",
  "name_on_card": "sample string 3",
  "card_type": "sample string 4",
  "masked_card_number": "sample string 5",
  "expiry_month": "sample string 6",
  "expiry_year": "sample string 7",
  "billing_name": "sample string 8",
  "billing_email": "sample string 9",
  "billing_phone": "sample string 10",
  "billing_address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "province_state": "sample string 4",
    "country_code": "sample string 5",
    "postal_zip_code": "sample string 6"
  },
  "references": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "success": true,
  "message": "sample string 12",
  "message_code": 13,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}