PUT v1/ConsumerProfiles?timeout={timeout}

PUT Save Payments

Saves a ConsumerProfile with updated information

URI template

v1/ConsumerProfiles?timeout={timeout}

Note: XSVC-PaymentServiceId is a required header for this call

Request Information

URI Parameters

Name	Type	Additional information	Description
timeout	integer	Default value is 30000	The timeout for this command, in milliseconds

Body Parameters

The ConsumerProfile to add/update

ConsumerProfile

Name	Type	Additional information	Description
Payments	Collection of ConsumerPaymentMethod	Required	List of payments to store for this consumer
EMail	string	None.	The email address for the consumer in CPS
ReferenceId	string	None.	Reference Id for the consumer

Request Formats

application/json, text/json

Sample:

{
  "Payments": [
    {
      "$id": "2",
      "AccountNumber": "sample string 1",
      "ExpirationDate": "sample string 2",
      "Name": "sample string 3",
      "MethodType": 0
    },
    {
      "$ref": "2"
    }
  ],
  "EMail": "sample string 1",
  "ReferenceId": "sample string 2"
}

application/xml, text/xml

Sample:

<ConsumerProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Inbound">
  <EMail xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 1</EMail>
  <ReferenceId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 2</ReferenceId>
  <Payments>
    <ConsumerPaymentMethod>
      <ExpirationDate xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 2</ExpirationDate>
      <MethodType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</MethodType>
      <Name xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 3</Name>
      <AccountNumber>sample string 1</AccountNumber>
    </ConsumerPaymentMethod>
    <ConsumerPaymentMethod>
      <ExpirationDate xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 2</ExpirationDate>
      <MethodType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</MethodType>
      <Name xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 3</Name>
      <AccountNumber>sample string 1</AccountNumber>
    </ConsumerPaymentMethod>
  </Payments>
</ConsumerProfile>

Response Information

Resource Description

A StoreApiResponse

StoreApiResponse

Name	Type	Additional information	Description
TransactionId	globally unique identifier	None.	The Transaction Id on the POS
ResultCode	integer	None.	The Result Code returned by the POS
ResultMessage	string	None.	The message returned by the store api

Response Formats

application/json, text/json

Sample:

{
  "TransactionId": "00000000-0000-0000-0000-000000000000",
  "ResultCode": 123,
  "ResultMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<StoreApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses">
  <ResultCode>123</ResultCode>
  <ResultMessage>sample string 1</ResultMessage>
  <TransactionId>00000000-0000-0000-0000-000000000000</TransactionId>
</StoreApiResponse>