GET v1/Customers/{customerId}/Payments/Info
Retrieves the customers saved payments including some CPS information.
URI template
v1/Customers/{customerId}/Payments/InfoRequest 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
ConsumerPaymentName | 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": "ad1dd6c3-7ffb-4668-b68d-bb4233ee8c98", "CustomerProfileId": "4301ee11-882e-43b7-b765-6d69f53606ab", "CPSCompanyCode": "sample string 3", "Payments": [ { "$id": "2", "AccountId": "cc012c39-768a-484e-bcda-ead074caed64", "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": "6f2d9120-9174-46b7-92c4-41e14a5a3609", "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>ad1dd6c3-7ffb-4668-b68d-bb4233ee8c98</CPSCompanyID> <CustomerProfileId>4301ee11-882e-43b7-b765-6d69f53606ab</CustomerProfileId> <Payments> <ConsumerPaymentMethod> <AccountId>cc012c39-768a-484e-bcda-ead074caed64</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>6f2d9120-9174-46b7-92c4-41e14a5a3609</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>