GET v1/Customers/{customerId}/PaymentTokens

Retrieves the customers saved token payments

URI template

v1/Customers/{customerId}/PaymentTokens

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

The customer that we are retrieving the payments for

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

A Customer saved token payment that has the account id that is needed for in the SubmitOrder class. Known internal error is NotFound

Collection of PaymentToken
NameDescriptionTypeAdditional information
TokenNumber

Get or set the Card Token Number property

string

None.

MaskedTokenNumber

Get or set the MaskedCardNumber property

string

None.

ExpirationDate

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "TokenNumber": "sample string 1",
    "MaskedTokenNumber": "sample string 2",
    "ExpirationDate": "sample string 3"
  },
  {
    "$id": "2",
    "TokenNumber": "sample string 4",
    "MaskedTokenNumber": "sample string 5",
    "ExpirationDate": "sample string 6"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPaymentToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
  <PaymentToken>
    <ExpirationDate>sample string 3</ExpirationDate>
    <MaskedTokenNumber>sample string 2</MaskedTokenNumber>
    <TokenNumber>sample string 1</TokenNumber>
  </PaymentToken>
  <PaymentToken>
    <ExpirationDate>sample string 6</ExpirationDate>
    <MaskedTokenNumber>sample string 5</MaskedTokenNumber>
    <TokenNumber>sample string 4</TokenNumber>
  </PaymentToken>
</ArrayOfPaymentToken>