ClubReady Api

<back to all web services

AddPaymentAccount

The following routes are available for this service:
POST/sales/member/{MemberId}/payment/profileAdd Payment Profile for a Member
AddPaymentAccount Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Authentication Key
StoreIdqueryint?YesId of the store for the user
MemberIdpathintYesMember Id of the user to update their Payment Profile
AcctTokenbodystringYesThe AcctToken provided by creating a Payment Profile with the Vault Api
Last4bodystringNoLast 4 digits of the Payment Profile
ExpMonthbodyint?No2 digit expiration month **Required for Credit Card**

Valid Range: 1 - 12

ExpYearbodyint?No2 digit expiration year **Required for Credit Card**

Valid Range: 10 - 99

AcctTypebodyAcctType?No The Account Type of the Payment Profile **Required when adding Gift Card**
Common Values
TextNumericalAccount Type
VISA1Visa
MC2MasterCard
Disc3Discover
Amex4American Express
PC11Personal Checking
PS12Personal Savings
BC13Business Checking
Factor442Factor4 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
BnkRoutebodyint?NoBank Routing Number **Required for Bank Accounts**

Valid Range: 0 - 999999999

DoNotUpdatePaymentTypePreferencebodyboolNoSet to `true` to not set the user's Payment Type Preference when adding an on-file profile
IsTempbodyboolNoWhether the Payment Profile is Temporary (One time transactions and Gift Cards are IsTemp = `true`)
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
AddPaymentProfileRequest Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
AcctTokenformstringNo
Last4formstringNo
ExpMonthformint?No
ExpYearformint?No
AcctTypeformAcctType?No
BnkRouteformint?No
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalCodeformstringNo
CountryCodeformstringNo
UrbanizationformstringNo
DoNotUpdatePaymentTypePreferenceformboolNo
IsTempformboolNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
AcctType Enum:
NameValue
Uninitialized0Uninitialized
Visa1VISA
MC2MasterCard
Disc3Discover
Amex4American Express
Diners5Diners
JCB6JCB
enRoute7enRoute
PayPal8PayPal
BillMe9Bill Me Later
PC11Personal Checking
PS12Personal Savings
BC13Business Checking
BS14Business Savings
Becs15BECS Direct Debit
Bacs16BACS Direct Debit
Maestro20Maestro
Solo21Solo
VisaElectron22Visa Electron
CIBC23CIBC Convenience Card
RoyalBankCa24Royal Bank of Canada Client
TDCaTrust25TD Canada Trust Access Card
Scotia26Scotiabank Scotia Card
BMO27BMO ABM Card
HSBCCa28HSBC Canada Card
UnionPay29China UnionPay
InterPayment30InterPayment
Laser31Laser
UnknownCredit40Unknown Credit Card
TransArmor41TransArmor
Factor442Factor4
XPass43XPass
ConnectedAccount44Connected Account
UnknownBank45Unknown Bank Account
Error-1Error
RestrictedResourceType Enum:
Store
Chain
User
Undefined
AddPaymentProfileResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformstringNo
MessageformstringNo

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

HTTP + CSV

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

{"ApiKey":"String","StoreId":0,"MemberId":0,"AcctToken":"String","AuthToken":"String","Last4":"String","ExpMonth":0,"ExpYear":0,"AcctType":"Uninitialized","CardType":0,"BnkRoute":0,"DoNotUpdatePaymentTypePreference":false,"IsTemp":false,"RestrictedId":0,"RestrictedResourceType":"Chain","UserId":0,"FirstName":"String","MiddleName":"String","LastName":"String","Address1":"String","Address2":"String","City":"String","State":"String","PostalCode":"String","CountryCode":"String","Urbanization":"String","ChainId":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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