ClubReady Api

AddPaymentAccount

The following routes are available for this service:
POST	/sales/member/{MemberId}/payment/profile	Add Payment Profile for a Member

AddPaymentAccount Parameters:

Name

Parameter

Data Type

Required

Description

ApiKey

query

string

Yes

Api Authentication Key

StoreId

query

int?

Yes

Id of the store for the user

MemberId

path

int

Yes

Member Id of the user to update their Payment Profile

AcctToken

body

string

Yes

The AcctToken provided by creating a Payment Profile with the Vault Api

Last4

body

string

Last 4 digits of the Payment Profile

ExpMonth

body

int?

2 digit expiration month **Required for Credit Card**

Valid Range: 1 - 12

ExpYear

body

int?

2 digit expiration year **Required for Credit Card**

Valid Range: 10 - 99

AcctType

body

AcctType?

The Account Type of the Payment Profile **Required when adding Gift Card**

Common Values

Text	Numerical	Account Type
VISA	1	Visa
MC	2	MasterCard
Disc	3	Discover
Amex	4	American Express
PC	11	Personal Checking
PS	12	Personal Savings
BC	13	Business Checking
Factor4	42	Factor4 Gift Card

You may use the Text or the Numerical value.

Allowable Values

Uninitialized
Visa
MC
Disc
Amex
Diners
JCB
enRoute
PayPal
BillMe
PC
PS
BC
BS
Becs
Bacs
Maestro
Solo
VisaElectron
CIBC
RoyalBankCa
TDCaTrust
Scotia
BMO
HSBCCa
UnionPay
InterPayment
Laser
UnknownCredit
TransArmor
Factor4
XPass
ConnectedAccount
UnknownBank
Error

BnkRoute

body

int?

Bank Routing Number **Required for Bank Accounts**

Valid Range: 0 - 999999999

DoNotUpdatePaymentTypePreference

body

bool

Set to `true` to not set the user's Payment Type Preference when adding an on-file profile

IsTemp

body

bool

Whether the Payment Profile is Temporary (One time transactions and Gift Cards are IsTemp = `true`)

RestrictedId

body

int?

RestrictedResourceType

body

RestrictedResourceType

**AddPaymentProfileRequest** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
AcctToken	form	string	No
Last4	form	string	No
ExpMonth	form	int?	No
ExpYear	form	int?	No
AcctType	form	AcctType?	No
BnkRoute	form	int?	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
PostalCode	form	string	No
CountryCode	form	string	No
Urbanization	form	string	No
DoNotUpdatePaymentTypePreference	form	bool	No
IsTemp	form	bool	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

**AcctType** Enum:
Name	Value
Uninitialized	0	Uninitialized
Visa	1	VISA
MC	2	MasterCard
Disc	3	Discover
Amex	4	American Express
Diners	5	Diners
JCB	6	JCB
enRoute	7	enRoute
PayPal	8	PayPal
BillMe	9	Bill Me Later
PC	11	Personal Checking
PS	12	Personal Savings
BC	13	Business Checking
BS	14	Business Savings
Becs	15	BECS Direct Debit
Bacs	16	BACS Direct Debit
Maestro	20	Maestro
Solo	21	Solo
VisaElectron	22	Visa Electron
CIBC	23	CIBC Convenience Card
RoyalBankCa	24	Royal Bank of Canada Client
TDCaTrust	25	TD Canada Trust Access Card
Scotia	26	Scotiabank Scotia Card
BMO	27	BMO ABM Card
HSBCCa	28	HSBC Canada Card
UnionPay	29	China UnionPay
InterPayment	30	InterPayment
Laser	31	Laser
UnknownCredit	40	Unknown Credit Card
TransArmor	41	TransArmor
Factor4	42	Factor4
XPass	43	XPass
ConnectedAccount	44	Connected Account
UnknownBank	45	Unknown Bank Account
Error	-1	Error

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**AddPaymentProfileResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	string	No
Message	form	string	No

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.

POST /sales/member/{MemberId}/payment/profile HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddPaymentAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.Model">
  <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.Core.Api.Models">String</AcctToken>
  <AcctType xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">Uninitialized</AcctType>
  <Address1 xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Address1>
  <Address2 xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Address2>
  <BnkRoute xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</BnkRoute>
  <City xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</City>
  <CountryCode xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</CountryCode>
  <DoNotUpdatePaymentTypePreference xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</DoNotUpdatePaymentTypePreference>
  <ExpMonth xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ExpMonth>
  <ExpYear xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ExpYear>
  <FirstName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</FirstName>
  <IsTemp xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</IsTemp>
  <Last4 xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Last4>
  <LastName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</LastName>
  <MiddleName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</MiddleName>
  <PostalCode xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</PostalCode>
  <State xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</State>
  <Urbanization xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Urbanization>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
  <AuthToken>String</AuthToken>
  <CardType>0</CardType>
  <MemberId>0</MemberId>
</AddPaymentAccount>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddPaymentProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
  <Message>String</Message>
  <Success>String</Success>
</AddPaymentProfileResponse>