GET v1/Customers/{customerId}/Payments/Info

Retrieves the customers saved payments including some CPS information.

URI template

v1/Customers/{customerId}/Payments/Info

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	The customer that we are retrieving the payments for	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

A consumer payment that has payment id and information as well as a list of ConsumerPaymentMethod objects. This includes some CPS information. Known internal error is BadRequest

ConsumerPayment

Name	Description	Type	Additional information
CPSCompanyID	The internal id for the company in CPS	globally unique identifier	None.
CustomerProfileId	The internal id for the customer in CPS	globally unique identifier	None.
CPSCompanyCode	The Company Code for the company when interacting with CPS	string	None.
Payments	List of all valid payments for this Customer	Collection of ConsumerPaymentMethod	None.

Response Formats

application/json, text/json

Sample:

{
  "CPSCompanyID": "2c791913-c51b-4a5f-9841-a55cceb0dc17",
  "CustomerProfileId": "5a04d59a-a709-4dc3-9d4e-b8c9025e0844",
  "CPSCompanyCode": "sample string 3",
  "Payments": [
    {
      "$id": "2",
      "AccountId": "f1ed68bf-4974-4632-bbf8-6e207acfedbf",
      "MethodType": 0,
      "AccountNumber": "sample string 5",
      "ExpirationDate": "sample string 6",
      "SecurityCode": "sample string 7",
      "ZipCode": "sample string 8",
      "MaskedAccountNumber": "sample string 9",
      "MaskedExpirationDate": "sample string 10",
      "ProviderType": 2
    },
    {
      "$id": "3",
      "AccountId": "8d90d7a1-92c1-4e80-a53c-72ee9bfffab9",
      "MethodType": 0,
      "AccountNumber": "sample string 12",
      "ExpirationDate": "sample string 13",
      "SecurityCode": "sample string 14",
      "ZipCode": "sample string 15",
      "MaskedAccountNumber": "sample string 16",
      "MaskedExpirationDate": "sample string 17",
      "ProviderType": 2
    }
  ]
}

application/xml, text/xml

Sample:

<ConsumerPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response">
  <CPSCompanyCode>sample string 3</CPSCompanyCode>
  <CPSCompanyID>2c791913-c51b-4a5f-9841-a55cceb0dc17</CPSCompanyID>
  <CustomerProfileId>5a04d59a-a709-4dc3-9d4e-b8c9025e0844</CustomerProfileId>
  <Payments>
    <ConsumerPaymentMethod>
      <AccountId>f1ed68bf-4974-4632-bbf8-6e207acfedbf</AccountId>
      <AccountNumber>sample string 5</AccountNumber>
      <ExpirationDate>sample string 6</ExpirationDate>
      <MaskedAccountNumber>sample string 9</MaskedAccountNumber>
      <MaskedExpirationDate>sample string 10</MaskedExpirationDate>
      <MethodType>Amex</MethodType>
      <ProviderType>ConnectedPayments</ProviderType>
      <SecurityCode>sample string 7</SecurityCode>
      <ZipCode>sample string 8</ZipCode>
    </ConsumerPaymentMethod>
    <ConsumerPaymentMethod>
      <AccountId>8d90d7a1-92c1-4e80-a53c-72ee9bfffab9</AccountId>
      <AccountNumber>sample string 12</AccountNumber>
      <ExpirationDate>sample string 13</ExpirationDate>
      <MaskedAccountNumber>sample string 16</MaskedAccountNumber>
      <MaskedExpirationDate>sample string 17</MaskedExpirationDate>
      <MethodType>Amex</MethodType>
      <ProviderType>ConnectedPayments</ProviderType>
      <SecurityCode>sample string 14</SecurityCode>
      <ZipCode>sample string 15</ZipCode>
    </ConsumerPaymentMethod>
  </Payments>
</ConsumerPayment>