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.

import java.math.*
import java.util.*
import net.servicestack.client.*


open class PaymentProfileUpdateEndpoint : PaymentProfileUpdateRequestDto()
{
    /**
    * Grants access to resources
    */
    @ApiMember(Description="Grants access to resources", IsRequired=true)
    var ApiKey:String? = null

    /**
    * AcctToken to update
    */
    @ApiMember(Description="AcctToken to update", IsRequired=true)
    var AcctToken:String? = null

    /**
    * UserId that is updating profile
    */
    @ApiMember(Description="UserId that is updating profile", IsRequired=true)
    var ModifiedBy:Int? = null

    /**
    * Expiry Month: 1 = January, 12 = December
    */
    @ApiMember(Description="Expiry Month: 1 = January, 12 = December")
    var CcExpMonth:Short? = null

    /**
    * Expiry Year: Two digit year
    */
    @ApiMember(Description="Expiry Year: Two digit year")
    var CcExpYear:Short? = null

    /**
    * The name can be provided with FullName OR as separate fields (PrefixName, FirstName, MiddleName, LastName, SuffixName).<br />Providing both will cause an error.
    */
    @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.")
    var FullName:String? = null

    @ApiMember()
    var PrefixName:String? = null

    @ApiMember()
    var FirstName:String? = null

    @ApiMember()
    var MiddleName:String? = null

    @ApiMember()
    var LastName:String? = null

    @ApiMember()
    var SuffixName:String? = null

    @ApiMember()
    var Address1:String? = null

    @ApiMember()
    var Address2:String? = null

    @ApiMember()
    var Urbanization:String? = null

    @ApiMember()
    var City:String? = null

    @ApiMember()
    var State:String? = null

    @ApiMember()
    var PostalCode:String? = null

    /**
    * Disable (or Enabled) the Payment Profile
    */
    @ApiMember(Description="Disable (or Enabled) the Payment Profile")
    var IsDisabled:Boolean? = null

    /**
    * Exclude (or Include) from Account Updater
    */
    @ApiMember(Description="Exclude (or Include) from Account Updater")
    var ExcludeFromAcctUpdater:Boolean? = null
}

open class PaymentProfileUpdateRequestDto : ApiDtoBase()
{
    var AcctToken:String? = null
    var ModifiedBy:Int? = null
    var CcExpMonth:Short? = null
    var CcExpYear:Short? = null
    var FullName:String? = null
    var PrefixName:String? = null
    var FirstName:String? = null
    var MiddleName:String? = null
    var LastName:String? = null
    var SuffixName:String? = null
    var Address1:String? = null
    var Address2:String? = null
    var Urbanization:String? = null
    var City:String? = null
    var State:String? = null
    var PostalCode:String? = null
    var IsDisabled:Boolean? = null
    var ExcludeFromAcctUpdater:Boolean? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

open class PaymentProfileUpdateResponse : PaymentProfileUpdateResponseDto()
{
}

open class PaymentProfileUpdateResponseDto : ApiResponseBase()
{
}

open class ApiResponseBase
{
    var Success:Boolean? = null
    var Message:String? = null
}

Kotlin 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: 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>