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.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Sales.Wallet
Imports ClubReady.Sales.Wallet
Imports ClubReady.Core.Api.Models

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class

        Public Partial Class ApiResponseBase
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class
    End Namespace

    Namespace ClubReady.Sales.Wallet

        Public Partial Class PaymentProfileUpdateRequestDto
            Inherits ApiDtoBase
            Public Overridable Property AcctToken As String
            Public Overridable Property ModifiedBy As Nullable(Of Integer)
            Public Overridable Property CcExpMonth As Nullable(Of Byte)
            Public Overridable Property CcExpYear As Nullable(Of Byte)
            Public Overridable Property FullName As String
            Public Overridable Property PrefixName As String
            Public Overridable Property FirstName As String
            Public Overridable Property MiddleName As String
            Public Overridable Property LastName As String
            Public Overridable Property SuffixName As String
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property Urbanization As String
            Public Overridable Property City As String
            Public Overridable Property State As String
            Public Overridable Property PostalCode As String
            Public Overridable Property IsDisabled As Nullable(Of Boolean)
            Public Overridable Property ExcludeFromAcctUpdater As Nullable(Of Boolean)
        End Class

        Public Partial Class PaymentProfileUpdateResponseDto
            Inherits ApiResponseBase
        End Class
    End Namespace

    Namespace ClubReady.Web.Api.Sales.Wallet

        Public Partial Class PaymentProfileUpdateEndpoint
            Inherits PaymentProfileUpdateRequestDto
            '''<Summary>
            '''Grants access to resources
            '''</Summary>
            <ApiMember(Description:="Grants access to resources", IsRequired:=true)>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''AcctToken to update
            '''</Summary>
            <ApiMember(Description:="AcctToken to update", IsRequired:=true)>
            Public Overridable Property AcctToken As String

            '''<Summary>
            '''UserId that is updating profile
            '''</Summary>
            <ApiMember(Description:="UserId that is updating profile", IsRequired:=true)>
            Public Overridable Property ModifiedBy As Nullable(Of Integer)

            '''<Summary>
            '''Expiry Month: 1 = January, 12 = December
            '''</Summary>
            <ApiMember(Description:="Expiry Month: 1 = January, 12 = December")>
            Public Overridable Property CcExpMonth As Nullable(Of Byte)

            '''<Summary>
            '''Expiry Year: Two digit year
            '''</Summary>
            <ApiMember(Description:="Expiry Year: Two digit year")>
            Public Overridable Property CcExpYear As Nullable(Of Byte)

            '''<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 Overridable Property FullName As String

            <ApiMember>
            Public Overridable Property PrefixName As String

            <ApiMember>
            Public Overridable Property FirstName As String

            <ApiMember>
            Public Overridable Property MiddleName As String

            <ApiMember>
            Public Overridable Property LastName As String

            <ApiMember>
            Public Overridable Property SuffixName As String

            <ApiMember>
            Public Overridable Property Address1 As String

            <ApiMember>
            Public Overridable Property Address2 As String

            <ApiMember>
            Public Overridable Property Urbanization As String

            <ApiMember>
            Public Overridable Property City As String

            <ApiMember>
            Public Overridable Property State As String

            <ApiMember>
            Public Overridable Property PostalCode As String

            '''<Summary>
            '''Disable (or Enabled) the Payment Profile
            '''</Summary>
            <ApiMember(Description:="Disable (or Enabled) the Payment Profile")>
            Public Overridable Property IsDisabled As Nullable(Of Boolean)

            '''<Summary>
            '''Exclude (or Include) from Account Updater
            '''</Summary>
            <ApiMember(Description:="Exclude (or Include) from Account Updater")>
            Public Overridable Property ExcludeFromAcctUpdater As Nullable(Of Boolean)
        End Class

        Public Partial Class PaymentProfileUpdateResponse
            Inherits PaymentProfileUpdateResponseDto
        End Class
    End Namespace
End Namespace

VB.NET PaymentProfileUpdateEndpoint DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length

{
	Success: False,
	Message: String
}