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.
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"String","AcctToken":"String","ModifiedBy":0,"CcExpMonth":0,"CcExpYear":0,"FullName":"String","PrefixName":"String","FirstName":"String","MiddleName":"String","LastName":"String","SuffixName":"String","Address1":"String","Address2":"String","Urbanization":"String","City":"String","State":"String","PostalCode":"String","IsDisabled":false,"ExcludeFromAcctUpdater":false,"StoreId":0,"ChainId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Success":false,"Message":"String"}