ClubReady Api

PaymentProfileUpdateEndpoint

The following routes are available for this service:
PUT	/sales/wallet/paymentprofileupdate	Update the personal information of a Payment Profile	Omitting 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.

namespace ClubReady.Core.Api.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiResponseBase() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type PaymentProfileUpdateResponseDto() = 
        inherit ApiResponseBase()

    [<AllowNullLiteral>]
    type PaymentProfileUpdateResponse() = 
        inherit PaymentProfileUpdateResponseDto()

    [<AllowNullLiteral>]
    type ApiDtoBase() = 
        member val ApiKey:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type PaymentProfileUpdateRequestDto() = 
        inherit ApiDtoBase()
        member val AcctToken:String = null with get,set
        member val ModifiedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CcExpMonth:Nullable<Byte> = new Nullable<Byte>() with get,set
        member val CcExpYear:Nullable<Byte> = new Nullable<Byte>() with get,set
        member val FullName:String = null with get,set
        member val PrefixName:String = null with get,set
        member val FirstName:String = null with get,set
        member val MiddleName:String = null with get,set
        member val LastName:String = null with get,set
        member val SuffixName:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val Urbanization:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val PostalCode:String = null with get,set
        member val IsDisabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ExcludeFromAcctUpdater:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type PaymentProfileUpdateEndpoint() = 
        inherit PaymentProfileUpdateRequestDto()
        ///<summary>
        ///Grants access to resources
        ///</summary>
        [<ApiMember(Description="Grants access to resources", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///AcctToken to update
        ///</summary>
        [<ApiMember(Description="AcctToken to update", IsRequired=true)>]
        member val AcctToken:String = null with get,set

        ///<summary>
        ///UserId that is updating profile
        ///</summary>
        [<ApiMember(Description="UserId that is updating profile", IsRequired=true)>]
        member val ModifiedBy:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Expiry Month: 1 = January, 12 = December
        ///</summary>
        [<ApiMember(Description="Expiry Month: 1 = January, 12 = December")>]
        member val CcExpMonth:Nullable<Byte> = new Nullable<Byte>() with get,set

        ///<summary>
        ///Expiry Year: Two digit year
        ///</summary>
        [<ApiMember(Description="Expiry Year: Two digit year")>]
        member val CcExpYear:Nullable<Byte> = new Nullable<Byte>() with 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.")>]
        member val FullName:String = null with get,set

        [<ApiMember>]
        member val PrefixName:String = null with get,set

        [<ApiMember>]
        member val FirstName:String = null with get,set

        [<ApiMember>]
        member val MiddleName:String = null with get,set

        [<ApiMember>]
        member val LastName:String = null with get,set

        [<ApiMember>]
        member val SuffixName:String = null with get,set

        [<ApiMember>]
        member val Address1:String = null with get,set

        [<ApiMember>]
        member val Address2:String = null with get,set

        [<ApiMember>]
        member val Urbanization:String = null with get,set

        [<ApiMember>]
        member val City:String = null with get,set

        [<ApiMember>]
        member val State:String = null with get,set

        [<ApiMember>]
        member val PostalCode:String = null with get,set

        ///<summary>
        ///Disable (or Enabled) the Payment Profile
        ///</summary>
        [<ApiMember(Description="Disable (or Enabled) the Payment Profile")>]
        member val IsDisabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///Exclude (or Include) from Account Updater
        ///</summary>
        [<ApiMember(Description="Exclude (or Include) from Account Updater")>]
        member val ExcludeFromAcctUpdater:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# 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>