Customer Token

Get customer token

get

Retrieve the payment token associated with the customer identified by the specified customer key.

Path parameters

customerKeystringRequired

Unique identifier of the customer.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: customer-tokens

401

Unauthorized

403

Forbidden

404

Not Found

get/rest/v2/customers/{customerKey}/tokens

GET /rest/v2/customers/{customerKey}/tokens HTTP/1.1
api-key: text
Accept: */*

{
  "customer-tokens": {
    "token": [
      {
        "customer-key": "custID-dkke-8383-ek999",
        "token-id": "11000383833939381111",
        "exp-date": "0932",
        "card-type": "VISA",
        "last-four-digits": "5678",
        "description": "joint debit",
        "default": true,
        "avs-address": "123 example street",
        "avs-zip": "123445"
      }
    ]
  },
  "payloadType": "customer-tokens"
}

Add customer token

post

Add an existing payment token to the customer identified by the specified customer key.

Path parameters

customerKeystringRequired

Unique identifier of the customer.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

Represents a stored payment token for a customer.

customer-keystringRequired

Unique identifier of the customer to associate with the token.

Example: custID-dkke-8383-ek999

token-idstringRequired

Unique identifier of the existing payment token that represents the card number.

Example: 11000383833939381111

exp-datestringRequired

Expire date of the card (MMYY).

Example: 0932

card-typestring · enumRequired

Type of payment card associated with the token.

Example: VISAPossible values:

last-four-digitsstringRequired

Last four digits of the card number associated with the token.

Example: 5678

descriptionstringOptional

Description of the customer's card to help identify the payment method.

Example: joint debit

defaultbooleanOptional

Indicates whether this card is the default payment method for the customer.

Example: true

avs-addressstringOptional

Street address used for Address Verification Service (AVS) validation for the payment card.

Example: 123 example street

avs-zipstringOptional

ZIP or postal code used for Address Verification Service (AVS) validation.

Example: 123445

Responses

200

ok

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: customer-tokens

401

Unauthorized

403

Forbidden

404

Not Found

post/rest/v2/customers/{customerKey}/tokens

POST /rest/v2/customers/{customerKey}/tokens HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "customer-key": "custID-dkke-8383-ek999",
  "token-id": "11000383833939381111",
  "exp-date": "0932",
  "card-type": "VISA",
  "last-four-digits": "5678",
  "description": "joint debit",
  "default": true,
  "avs-address": "123 example street",
  "avs-zip": "123445"
}

{
  "customer-tokens": {
    "token": [
      {
        "customer-key": "custID-dkke-8383-ek999",
        "token-id": "11000383833939381111",
        "exp-date": "0932",
        "card-type": "VISA",
        "last-four-digits": "5678",
        "description": "joint debit",
        "default": true,
        "avs-address": "123 example street",
        "avs-zip": "123445"
      }
    ]
  },
  "payloadType": "customer-tokens"
}

Update customer token

put

Update the customer-key, status (ACTIVE, INACTIVE, or DELETED), or description of an existing payment token associated with the specified customer. To update other token details, you must delete the token and create a new one.

Path parameters

customerKeystringRequired

Unique identifier of the customer.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

Represents a stored payment token for a customer.

customer-keystringRequired

Unique identifier of the customer to associate with the token.

Example: custID-dkke-8383-ek999

token-idstringRequired

Unique identifier of the existing payment token that represents the card number.

Example: 11000383833939381111

exp-datestringRequired

Expire date of the card (MMYY).

Example: 0932

card-typestring · enumRequired

Type of payment card associated with the token.

Example: VISAPossible values:

last-four-digitsstringRequired

Last four digits of the card number associated with the token.

Example: 5678

descriptionstringOptional

Description of the customer's card to help identify the payment method.

Example: joint debit

defaultbooleanOptional

Indicates whether this card is the default payment method for the customer.

Example: true

avs-addressstringOptional

Street address used for Address Verification Service (AVS) validation for the payment card.

Example: 123 example street

avs-zipstringOptional

ZIP or postal code used for Address Verification Service (AVS) validation.

Example: 123445

Responses

200

ok

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: customer-tokens

401

Unauthorized

403

Forbidden

404

Not Found

put/rest/v2/customers/{customerKey}/tokens

PUT /rest/v2/customers/{customerKey}/tokens HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "customer-key": "custID-dkke-8383-ek999",
  "token-id": "11000383833939381111",
  "exp-date": "0932",
  "card-type": "VISA",
  "last-four-digits": "5678",
  "description": "joint debit",
  "default": true,
  "avs-address": "123 example street",
  "avs-zip": "123445"
}

{
  "customer-tokens": {
    "token": [
      {
        "customer-key": "custID-dkke-8383-ek999",
        "token-id": "11000383833939381111",
        "exp-date": "0932",
        "card-type": "VISA",
        "last-four-digits": "5678",
        "description": "joint debit",
        "default": true,
        "avs-address": "123 example street",
        "avs-zip": "123445"
      }
    ]
  },
  "payloadType": "customer-tokens"
}