GET v1/ConsumerProfiles/{storeIdentifier}/ByReference?referenceId={referenceId}&timeout={timeout}

GET Saved Payments by Refernece Id

Retrieves a ConsumerProfile by ReferenceId to be used at a specific site

URI template

v1/ConsumerProfiles/{storeIdentifier}/ByReference?referenceId={referenceId}&timeout={timeout}

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

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	The store for the profile to be used at. If this value is 0, none of the consumer's sensitve data (e.g. credit card number) will be returned.
referenceId	string	Required	The Reference ID to be used to look up the consumer's profile
timeout	integer	Default value is 30000	The timeout for this command, in milliseconds

Body Parameters

None.

Response Information

Resource Description

A ConsumerProfileResponse containing an ApiResult for the command and a ConsumerProfile

ConsumerProfileResponse

Name	Type	Additional information	Description
ApiResult	StoreApiResponse	None.	The result returned by the Api
ConsumerProfile	OutConsumerProfile	None.	The profile stored for a consumer in CPS

Response Formats

application/json, text/json

Sample:

{
  "ConsumerProfile": {
    "$id": "2",
    "Payments": null,
    "EMail": null,
    "ReferenceId": null
  },
  "ApiResult": {
    "$id": "3",
    "TransactionId": "00000000-0000-0000-0000-000000000000",
    "ResultCode": 0,
    "ResultMessage": "Success"
  }
}

application/xml, text/xml

Sample:

<ConsumerProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects.ConsumerProfileResponses">
  <ApiResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Responses" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects">
    <d2p1:ResultCode>0</d2p1:ResultCode>
    <d2p1:ResultMessage>Success</d2p1:ResultMessage>
    <d2p1:TransactionId>00000000-0000-0000-0000-000000000000</d2p1:TransactionId>
  </ApiResult>
  <ConsumerProfile xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Outbound">
    <EMail i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <ReferenceId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <d2p1:Payments i:nil="true" />
  </ConsumerProfile>
</ConsumerProfileResponse>