ClubReady Api

SellContractAndSetupClientRequest

The following routes are available for this service:
POST	/sales/contract/sold/new/user	Create a user and sell them a package	Create a user and sell them a package. New Operation The PaymentMethods property is an array of objects describing how you want ClubReady to take payment while selling the PackageId/InstallmentPlanId. The deprecated fields (AcctToken, Last4, ExpMonth, ExpYear, AcctType, BnkRoute, and IsTemp) must be omitted or null. Deprecated Operation Provide the AcctToken, Last4, ExpMonth, ExpYear, AcctType, BnkRoute, and IsTemp used in the ClubReadyGateway API in order to create a Payment Profile to the user specified. PaymentMethods must be omitted or null.

SellContractAndSetupClientRequest Parameters:

Name

Parameter

Data Type

Required

Description

ApiKey

query

string

Yes

Api Authentication Key

ChainId

query

int?

Id for the chain of the Api Key

StoreId

query

int?

Yes

Id of the store for the user

PackageId

body

int

Yes

Package Id being sold

InstallmentPlanId

body

int

Yes

Installment Plan Id being sold

PaymentAmount

body

decimal

Yes

Amount being paid

StartDate

body

DateTime?

Date contract takes affect

FirstName

body

string

Yes

First Name

LastName

body

string

Yes

Last Name

body

string

Yes

Email Address

Gender

body

string

Gender

Address

body

string

Address

City

body

string

City

State

body

string

State

Zip

body

string

Zip Code

Phone

body

string

Home phone

WorkPhone

body

string

Work phone

DateOfBirth

body

DateTime?

Date of Birth

CellPhone

body

string

Cell phone

Note

body

string

Add an internal note for the new prospect

ExternalId

body

string

Unique Id for the user from your system. We store internally as ExternalUserId

PromoCode

body

string

Promo code to apply a discount.

Username

body

string

Username should be between 4 and 255 characters long

ReferralTypeId

body

int?

ReferralTypeId

EmergencyContactName

body

string

Emergency contact name

EmergencyContactPhone

body

string

Emergency contact phone number

EmergencyContactType

body

string

Emergency contact relationship

PaymentMethods

body

List<PaymentMethodDto>

An array of Payment Methods to be used for this purchase. Any entry with PreferredOnFile is assumed if omitted or null. Each object of the array may contain properties: | Property | Description | | --- | --- | | PaymentMethodType | Usually "AcctToken" (Default or omitted/null) or "PreferredOnFile" | | PaymentAmount | The amount to be attempted for this Payment Method. When omitted (or null), the Request's PaymentAmount will be attempted | | AcctToken | The AcctToken to attempt payment (when using PaymentMethodType:AcctToken) | | ProfileToken | When provided (with AcctToken), a Payment Profile will be created (this will prevent the requirement to call `/sales/paymentprofile/import` (when using PaymentMethodType:AcctToken) | | DoNotUpdatePaymentTypePreference | When using ProfileToken, do not set the PaymentTypePreference (for more information, see `/sales/paymentprofile/import` (when using PaymentMethodType:AcctToken) | | | | * Scenario #1: Use a Gift Card with PreferredOnFile to cover the amount not approved by the Gift Card. JSON: ```json { PaymentMethods: [ { "PaymentMethodType":"AcctToken", "PaymentAmount":"1.00", "AcctToken":"eyJ...GiftCard AcctToken...", "ProfileToken":"eyJ...Gift Card ProfileToken..." }, { "PaymentMethodType":"PreferredOnFile", "PaymentAmount":"1.00" } ] } ``` JSV: ``` [{PaymentMethodType:AcctToken,PaymentAmount:1.00,AcctToken:eyj...,ProfileToken:eyJ...},{PaymentMethodType:PreferredOnFile,PaymentAmount:1.00}] ``` * Scenario #2: Use a Gift Card with PreferredOnFile to cover the amount not approved by the Gift Card. JSON: ```json { PaymentMethods: [ { "PaymentMethodType":"AcctToken", "PaymentAmount":"1.00", "AcctToken":"eyJ...GiftCard AcctToken...", "ProfileToken":"eyJ...Gift Card ProfileToken..." }, { "PaymentMethodType":"PreferredOnFile", "PaymentAmount":"1.00" } ] } ``` JSV: ```jsv [{PaymentMethodType:AcctToken,PaymentAmount:1.00,AcctToken:eyj...,ProfileToken:eyJ...},{PaymentMethodType:PreferredOnFile,PaymentAmount:1.00}] ``` Notes: * The example shows PaymentAmount of 1.00 for both "AcctToken" and "PreferredOnFile". This is for the example with a total of $1.00. The firstPaymentMethod (the Gift Card) will be attempted for $1.00. If it partially approves for less than 1.00 (example: $0.80), the second payment method (PreferredOnFile) will be attempted for the lesser of it's PaymentAmount and the remaining amount (example: $0.20). * Because this endpoint creates a new user, the "PreferredOnFile" option is not applicable. Also, ProfileToken with the OwnerType "TempstUser" is required because the Payment Profile owner will be converted to the newly created user. * When using Query String (or this web site), this value must be encoded with JSV [(JSON-like Separated Values)](https://docs.servicestack.net/jsv-format). Basic steps to convert JSON to JSV: 1) Remove properties that are null, 2) Remove white space including line feeds, 3) Remove quotes.

RestrictedId

body

int?

RestrictedResourceType

body

RestrictedResourceType

AcctToken

body

string

**Deprecated** (Use `PaymentMethods` with `ProfileToken`) AcctToken provided by creating a Payment Profile with the Vault Api. Required if Package requires purchase and PaymentMethods is empty.

Last4

body

string

**Deprecated** (Use `PaymentMethods` with `ProfileToken`) Last 4 digits of the Payment Profile. Required with AcctToken.

ExpMonth

body

int?

**Deprecated** (Use `PaymentMethods` with `ProfileToken`) 2 digit expiration month. **Required with AcctToken for Credit Card.**

ExpYear

body

int?

**Deprecated** (Use `PaymentMethods` with `ProfileToken`) 2 digit expiration year. **Required with AcctToken for Credit Card.**

AcctType

body

AcctType?

**Deprecated** (Use `PaymentMethods` with `ProfileToken`) The Account Type the Payment Profile

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

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?

**Deprecated** (Use `PaymentMethods` with `ProfileToken`) Bank Routing Number. **Required with AcctToken for Bank Accounts.**

Valid Range: 0 - 999999999

IsTemp

body

bool

**Deprecated** (Use `PaymentMethods` with `ProfileToken`) Whether the Payment Profile is Temporary. (One time transactions and Gift Cards are IsTemp = True).

**SellContractAndSetupClientDto** Parameters:
Name	Parameter	Data Type	Required
AcctToken	form	string	No
Last4	form	string	No
ExpMonth	form	int?	No
ExpYear	form	int?	No
AcctType	form	AcctType?	No
BnkRoute	form	int?	No
IsTemp	form	bool	No
PackageId	form	int	No
InstallmentPlanId	form	int	No
PaymentAmount	form	decimal	No
StartDate	form	DateTime?	No
FirstName	form	string	No
LastName	form	string	No
Address	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Email	form	string	No
Gender	form	string	No
Phone	form	string	No
WorkPhone	form	string	No
DateOfBirth	form	DateTime?	No
CellPhone	form	string	No
Note	form	string	No
ExternalId	form	string	No
PromoCode	form	string	No
Username	form	string	No
ReferralTypeId	form	int?	No
EmergencyContactName	form	string	No
EmergencyContactPhone	form	string	No
EmergencyContactType	form	string	No
PaymentMethods	form	List<PaymentMethodDto>	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

**PaymentMethodDto** Parameters:
Name	Parameter	Data Type	Required
AcctToken	form	string	No
ProfileToken	form	string	No
PaymentProfileId	form	string	No
PaymentAmount	form	decimal?	No
PaymentMethodType	form	PaymentMethodType?	No
DoNotUpdatePaymentTypePreference	form	bool?	No

**PaymentMethodType** Enum:
Name	Value
Uninitialized	0	Uninitialized
PaymentProfileId	1	PaymentProfileId
PreferredOnFile	2	PreferredOnFile
AcctToken	3	AcctToken
Error	-1	Error

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

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/contract/sold/new/user HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SellContractAndSetupClientRequest 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>
  <Address xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Address>
  <BnkRoute xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</BnkRoute>
  <CellPhone xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</CellPhone>
  <City xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</City>
  <DateOfBirth xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0001-01-01T00:00:00</DateOfBirth>
  <Email xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Email>
  <EmergencyContactName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</EmergencyContactName>
  <EmergencyContactPhone xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</EmergencyContactPhone>
  <EmergencyContactType xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</EmergencyContactType>
  <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>
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ExternalId>
  <FirstName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</FirstName>
  <Gender xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Gender>
  <InstallmentPlanId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</InstallmentPlanId>
  <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>
  <Note xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Note>
  <PackageId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</PackageId>
  <PaymentAmount xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</PaymentAmount>
  <PaymentMethods xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <PaymentMethodDto>
      <AcctToken>String</AcctToken>
      <DoNotUpdatePaymentTypePreference>false</DoNotUpdatePaymentTypePreference>
      <PaymentAmount>0</PaymentAmount>
      <PaymentMethodType>Uninitialized</PaymentMethodType>
      <PaymentProfileId>String</PaymentProfileId>
      <ProfileToken>String</ProfileToken>
    </PaymentMethodDto>
  </PaymentMethods>
  <Phone xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Phone>
  <PromoCode xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</PromoCode>
  <ReferralTypeId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ReferralTypeId>
  <StartDate xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0001-01-01T00:00:00</StartDate>
  <State xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</State>
  <Username xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Username>
  <WorkPhone xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</WorkPhone>
  <Zip xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Zip>
  <AuthToken>String</AuthToken>
  <CardType>0</CardType>
</SellContractAndSetupClientRequest>

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

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />