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.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Sales.Wallet;
using ClubReady.Sales.Wallet;
using ClubReady.Core.Api.Models;

namespace ClubReady.Core.Api.Models
{
    public partial class ApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class ApiResponseBase
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

}

namespace ClubReady.Sales.Wallet
{
    public partial class PaymentProfileUpdateRequestDto
        : ApiDtoBase
    {
        public virtual string AcctToken { get; set; }
        public virtual int? ModifiedBy { get; set; }
        public virtual byte? CcExpMonth { get; set; }
        public virtual byte? CcExpYear { get; set; }
        public virtual string FullName { get; set; }
        public virtual string PrefixName { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string MiddleName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string SuffixName { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string Urbanization { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string PostalCode { get; set; }
        public virtual bool? IsDisabled { get; set; }
        public virtual bool? ExcludeFromAcctUpdater { get; set; }
    }

    public partial class PaymentProfileUpdateResponseDto
        : ApiResponseBase
    {
    }

}

namespace ClubReady.Web.Api.Sales.Wallet
{
    public partial class PaymentProfileUpdateEndpoint
        : PaymentProfileUpdateRequestDto
    {
        ///<summary>
        ///Grants access to resources
        ///</summary>
        [ApiMember(Description="Grants access to resources", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///AcctToken to update
        ///</summary>
        [ApiMember(Description="AcctToken to update", IsRequired=true)]
        public virtual string AcctToken { get; set; }

        ///<summary>
        ///UserId that is updating profile
        ///</summary>
        [ApiMember(Description="UserId that is updating profile", IsRequired=true)]
        public virtual int? ModifiedBy { get; set; }

        ///<summary>
        ///Expiry Month: 1 = January, 12 = December
        ///</summary>
        [ApiMember(Description="Expiry Month: 1 = January, 12 = December")]
        public virtual byte? CcExpMonth { get; set; }

        ///<summary>
        ///Expiry Year: Two digit year
        ///</summary>
        [ApiMember(Description="Expiry Year: Two digit year")]
        public virtual byte? CcExpYear { get; set; }

        ///<summary>
        ///The name can be provided with FullName OR as separate fields (PrefixName, FirstName, MiddleName, LastName, SuffixName).<br />Providing both will cause an error.
        ///</summary>
        [ApiMember(Description="The name can be provided with FullName OR as separate fields (PrefixName, FirstName, MiddleName, LastName, SuffixName).<br />Providing both will cause an error.")]
        public virtual string FullName { get; set; }

        [ApiMember]
        public virtual string PrefixName { get; set; }

        [ApiMember]
        public virtual string FirstName { get; set; }

        [ApiMember]
        public virtual string MiddleName { get; set; }

        [ApiMember]
        public virtual string LastName { get; set; }

        [ApiMember]
        public virtual string SuffixName { get; set; }

        [ApiMember]
        public virtual string Address1 { get; set; }

        [ApiMember]
        public virtual string Address2 { get; set; }

        [ApiMember]
        public virtual string Urbanization { get; set; }

        [ApiMember]
        public virtual string City { get; set; }

        [ApiMember]
        public virtual string State { get; set; }

        [ApiMember]
        public virtual string PostalCode { get; set; }

        ///<summary>
        ///Disable (or Enabled) the Payment Profile
        ///</summary>
        [ApiMember(Description="Disable (or Enabled) the Payment Profile")]
        public virtual bool? IsDisabled { get; set; }

        ///<summary>
        ///Exclude (or Include) from Account Updater
        ///</summary>
        [ApiMember(Description="Exclude (or Include) from Account Updater")]
        public virtual bool? ExcludeFromAcctUpdater { get; set; }
    }

    public partial class PaymentProfileUpdateResponse
        : PaymentProfileUpdateResponseDto
    {
    }

}

C# PaymentProfileUpdateEndpoint DTOs

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: www.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>