GET v1/Customers/{customerId}/Payments

Retrieves the customers saved payments

URI template

v1/Customers/{customerId}/Payments

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 payment that has the account id that is needed for in the SubmitOrder class. Known internal error is NotFound

CustomerPayment
NameDescriptionTypeAdditional information
AccountId

Unique identifier for Token

globally unique identifier

None.

MethodType

Credit Card Type: Visa, MasterCard, etc...

CustomerPaymentMethodType

None.

AccountNumber

TokenType:TokenValue for ConnectedPayments

string

None.

ExpirationDate

Card's Expiration Date

string

None.

SecurityCode

Card's security code, not used in ConnectedPayments

string

None.

ZipCode

Card's zip code, not used in ConnectedPayments

string

None.

MaskedAccountNumber

Masked card number

string

None.

MaskedExpirationDate

Masked expiration date, not used in ConnectedPayments

string

None.

ProviderType

Payment provider type: CPS, BPoint, ConnectedPayments, etc...

Payment Provider Type

None.

Response Formats

application/json, text/json

Sample:
{
  "AccountId": "ae6cb077-ce0b-44ea-9d6e-3e5cfd5cbfd6",
  "MethodType": 0,
  "AccountNumber": "sample string 2",
  "ExpirationDate": "sample string 3",
  "SecurityCode": "sample string 4",
  "ZipCode": "sample string 5",
  "MaskedAccountNumber": "sample string 6",
  "MaskedExpirationDate": "sample string 7",
  "ProviderType": 2
}

application/xml, text/xml

Sample:
<CustomerPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
  <AccountId>ae6cb077-ce0b-44ea-9d6e-3e5cfd5cbfd6</AccountId>
  <AccountNumber>sample string 2</AccountNumber>
  <ExpirationDate>sample string 3</ExpirationDate>
  <MaskedAccountNumber>sample string 6</MaskedAccountNumber>
  <MaskedExpirationDate>sample string 7</MaskedExpirationDate>
  <MethodType>Amex</MethodType>
  <ProviderType>ConnectedPayments</ProviderType>
  <SecurityCode>sample string 4</SecurityCode>
  <ZipCode>sample string 5</ZipCode>
</CustomerPayment>