ClubReady Api

<back to all web services

PaymentProfileUpdateEndpoint

The following routes are available for this service:
PUT/sales/wallet/paymentprofileupdateUpdate the personal information of a Payment ProfileOmitting fields or providing `null` will not update that field.
Providing an empty or whitespace string will remove the data from the field.
To update the account information (Account Number, Last4, Country, etc), create a new Payment Profile.
PaymentProfileUpdateEndpoint Parameters:
NameParameterData TypeRequiredDescription
ApiKeybodystringYesGrants access to resources
AcctTokenbodystringYesAcctToken to update
ModifiedBybodyint?YesUserId that is updating profile
CcExpMonthbodybyte?NoExpiry Month: 1 = January, 12 = December
CcExpYearbodybyte?NoExpiry Year: Two digit year
FullNamebodystringNoThe name can be provided with FullName OR as separate fields (PrefixName, FirstName, MiddleName, LastName, SuffixName).
Providing both will cause an error.
PrefixNamebodystringNo
FirstNamebodystringNo
MiddleNamebodystringNo
LastNamebodystringNo
SuffixNamebodystringNo
Address1bodystringNo
Address2bodystringNo
UrbanizationbodystringNo
CitybodystringNo
StatebodystringNo
PostalCodebodystringNo
IsDisabledbodybool?NoDisable (or Enabled) the Payment Profile
ExcludeFromAcctUpdaterbodybool?NoExclude (or Include) from Account Updater
PaymentProfileUpdateRequestDto Parameters:
NameParameterData TypeRequiredDescription
AcctTokenformstringNo
ModifiedByformint?No
CcExpMonthformbyte?No
CcExpYearformbyte?No
FullNameformstringNo
PrefixNameformstringNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
SuffixNameformstringNo
Address1formstringNo
Address2formstringNo
UrbanizationformstringNo
CityformstringNo
StateformstringNo
PostalCodeformstringNo
IsDisabledformbool?No
ExcludeFromAcctUpdaterformbool?No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /sales/wallet/paymentprofileupdate HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaymentProfileUpdateEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.Wallet">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</StoreId>
  <AcctToken xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</AcctToken>
  <Address1 xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</Address1>
  <Address2 xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</Address2>
  <CcExpMonth xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">0</CcExpMonth>
  <CcExpYear xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">0</CcExpYear>
  <City xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</City>
  <ExcludeFromAcctUpdater xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">false</ExcludeFromAcctUpdater>
  <FirstName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</FirstName>
  <FullName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</FullName>
  <IsDisabled xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">false</IsDisabled>
  <LastName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</LastName>
  <MiddleName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</MiddleName>
  <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">0</ModifiedBy>
  <PostalCode xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</PostalCode>
  <PrefixName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</PrefixName>
  <State xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</State>
  <SuffixName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</SuffixName>
  <Urbanization xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</Urbanization>
</PaymentProfileUpdateEndpoint>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentProfileUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.Wallet">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
</PaymentProfileUpdateResponse>