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.


export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class PaymentProfileUpdateRequestDto extends ApiDtoBase
{
    public AcctToken?: string;
    public ModifiedBy?: number;
    public CcExpMonth?: number;
    public CcExpYear?: number;
    public FullName?: string;
    public PrefixName?: string;
    public FirstName?: string;
    public MiddleName?: string;
    public LastName?: string;
    public SuffixName?: string;
    public Address1?: string;
    public Address2?: string;
    public Urbanization?: string;
    public City?: string;
    public State?: string;
    public PostalCode?: string;
    public IsDisabled?: boolean;
    public ExcludeFromAcctUpdater?: boolean;

    public constructor(init?: Partial<PaymentProfileUpdateRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export class ApiResponseBase
{
    public Success: boolean;
    public Message: string;

    public constructor(init?: Partial<ApiResponseBase>) { (Object as any).assign(this, init); }
}

export class PaymentProfileUpdateResponseDto extends ApiResponseBase
{

    public constructor(init?: Partial<PaymentProfileUpdateResponseDto>) { super(init); (Object as any).assign(this, init); }
}

export class PaymentProfileUpdateResponse extends PaymentProfileUpdateResponseDto
{

    public constructor(init?: Partial<PaymentProfileUpdateResponse>) { super(init); (Object as any).assign(this, init); }
}

export class PaymentProfileUpdateEndpoint extends PaymentProfileUpdateRequestDto
{
    /**
    * Grants access to resources
    */
    // @ApiMember(Description="Grants access to resources", IsRequired=true)
    public ApiKey: string;

    /**
    * AcctToken to update
    */
    // @ApiMember(Description="AcctToken to update", IsRequired=true)
    public AcctToken: string;

    /**
    * UserId that is updating profile
    */
    // @ApiMember(Description="UserId that is updating profile", IsRequired=true)
    public ModifiedBy: number;

    /**
    * Expiry Month: 1 = January, 12 = December
    */
    // @ApiMember(Description="Expiry Month: 1 = January, 12 = December")
    public CcExpMonth?: number;

    /**
    * Expiry Year: Two digit year
    */
    // @ApiMember(Description="Expiry Year: Two digit year")
    public CcExpYear?: number;

    /**
    * 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.")
    public FullName?: string;

    // @ApiMember()
    public PrefixName?: string;

    // @ApiMember()
    public FirstName?: string;

    // @ApiMember()
    public MiddleName?: string;

    // @ApiMember()
    public LastName?: string;

    // @ApiMember()
    public SuffixName?: string;

    // @ApiMember()
    public Address1?: string;

    // @ApiMember()
    public Address2?: string;

    // @ApiMember()
    public Urbanization?: string;

    // @ApiMember()
    public City?: string;

    // @ApiMember()
    public State?: string;

    // @ApiMember()
    public PostalCode?: string;

    /**
    * Disable (or Enabled) the Payment Profile
    */
    // @ApiMember(Description="Disable (or Enabled) the Payment Profile")
    public IsDisabled?: boolean;

    /**
    * Exclude (or Include) from Account Updater
    */
    // @ApiMember(Description="Exclude (or Include) from Account Updater")
    public ExcludeFromAcctUpdater?: boolean;

    public constructor(init?: Partial<PaymentProfileUpdateEndpoint>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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
}