| 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. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@ApiResponse(Description="", ResponseType=SellContractAndSetupClientResponse.class, StatusCode=200)
open class SellContractAndSetupClientRequest : SellContractAndSetupClientDto(), IRestrictedApiRequest
{
/**
* Api Authentication Key
*/
@ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
var ApiKey:String? = null
/**
* Id for the chain of the Api Key
*/
@ApiMember(Description="Id for the chain of the Api Key", ParameterType="query")
var ChainId:Int? = null
/**
* Id of the store for the user
*/
@ApiMember(Description="Id of the store for the user", IsRequired=true, ParameterType="query")
var StoreId:Int? = null
/**
* Package Id being sold
*/
@ApiMember(Description="Package Id being sold", IsRequired=true)
var PackageId:Int? = null
/**
* Installment Plan Id being sold
*/
@ApiMember(Description="Installment Plan Id being sold", IsRequired=true)
var InstallmentPlanId:Int? = null
/**
* Amount being paid
*/
@ApiMember(Description="Amount being paid", IsRequired=true)
var PaymentAmount:BigDecimal? = null
/**
* Date contract takes affect
*/
@ApiMember(Description="Date contract takes affect")
var StartDate:Date? = null
/**
* First Name
*/
@ApiMember(Description="First Name", IsRequired=true)
var FirstName:String? = null
/**
* Last Name
*/
@ApiMember(Description="Last Name", IsRequired=true)
var LastName:String? = null
/**
* Email Address
*/
@ApiMember(Description="Email Address", IsRequired=true)
var Email:String? = null
/**
* Gender
*/
@ApiMember(Description="Gender")
var Gender:String? = null
/**
* Address
*/
@ApiMember(Description="Address")
var Address:String? = null
/**
* City
*/
@ApiMember(Description="City")
var City:String? = null
/**
* State
*/
@ApiMember(Description="State")
var State:String? = null
/**
* Zip Code
*/
@ApiMember(Description="Zip Code")
var Zip:String? = null
/**
* Home phone
*/
@ApiMember(Description="Home phone")
var Phone:String? = null
/**
* Work phone
*/
@ApiMember(Description="Work phone")
var WorkPhone:String? = null
/**
* Date of Birth
*/
@ApiMember(Description="Date of Birth")
var DateOfBirth:Date? = null
/**
* Cell phone
*/
@ApiMember(Description="Cell phone")
var CellPhone:String? = null
/**
* Add an internal note for the new prospect
*/
@ApiMember(Description="Add an internal note for the new prospect")
var Note:String? = null
/**
* Unique Id for the user from your system. We store internally as ExternalUserId
*/
@ApiMember(Description="Unique Id for the user from your system. We store internally as ExternalUserId")
var ExternalId:String? = null
/**
* Promo code to apply a discount.
*/
@ApiMember(Description="Promo code to apply a discount.")
var PromoCode:String? = null
/**
* Username should be between 4 and 255 characters long
*/
@ApiMember(Description="Username should be between 4 and 255 characters long")
var Username:String? = null
/**
* ReferralTypeId
*/
@ApiMember(Description="ReferralTypeId")
var ReferralTypeId:Int? = null
/**
* Emergency contact name
*/
@ApiMember(Description="Emergency contact name")
var EmergencyContactName:String? = null
/**
* Emergency contact phone number
*/
@ApiMember(Description="Emergency contact phone number")
var EmergencyContactPhone:String? = null
/**
* Emergency contact relationship
*/
@ApiMember(Description="Emergency contact relationship")
var EmergencyContactType:String? = null
/**
* 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 examplewith a total of $1.00. The firstPaymentMethod (the Gift Card) will be attempted for $1.00. If it partially approvesfor less than 1.00 (example: $0.80), the second payment method (PreferredOnFile) will be attempted for the lesser ofit's PaymentAmount and the remaining amount (example: $0.20).* Because this endpoint creates a new user, the "PreferredOnFile" option is not applicable. Also, ProfileToken withthe 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.
*/
@ApiMember(Description="\r\nAn array of Payment Methods to be used for this purchase. Any entry with PreferredOnFile is assumed if omitted or null. \r\n\r\nEach object of the array may contain properties:\r\n\r\n| Property | Description |\r\n| --- | --- |\r\n| PaymentMethodType | Usually \"AcctToken\" (Default or omitted/null) or \"PreferredOnFile\" |\r\n| PaymentAmount | The amount to be attempted for this Payment Method. When omitted (or null), the Request's PaymentAmount will be attempted |\r\n| AcctToken | The AcctToken to attempt payment (when using PaymentMethodType:AcctToken) |\r\n| 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) |\r\n| DoNotUpdatePaymentTypePreference | When using ProfileToken, do not set the PaymentTypePreference (for more information, see `/sales/paymentprofile/import` (when using PaymentMethodType:AcctToken) |\r\n| | |\r\n\r\n* Scenario #1: Use a Gift Card with PreferredOnFile to cover the amount not approved by the Gift Card. \r\n\r\nJSON:\r\n```json\r\n{\r\n PaymentMethods: [\r\n {\r\n \"PaymentMethodType\":\"AcctToken\",\r\n \"PaymentAmount\":\"1.00\",\r\n \"AcctToken\":\"eyJ...GiftCard AcctToken...\",\r\n \"ProfileToken\":\"eyJ...Gift Card ProfileToken...\"\r\n },\r\n {\r\n \"PaymentMethodType\":\"PreferredOnFile\",\r\n \"PaymentAmount\":\"1.00\"\r\n }\r\n ]\r\n}\r\n```\r\nJSV:\r\n```\r\n[{PaymentMethodType:AcctToken,PaymentAmount:1.00,AcctToken:eyj...,ProfileToken:eyJ...},{PaymentMethodType:PreferredOnFile,PaymentAmount:1.00}]\r\n```\r\n\r\n* Scenario #2: Use a Gift Card with PreferredOnFile to cover the amount not approved by the Gift Card. \r\n\r\nJSON:\r\n```json\r\n{\r\n PaymentMethods: [\r\n {\r\n \"PaymentMethodType\":\"AcctToken\",\r\n \"PaymentAmount\":\"1.00\",\r\n \"AcctToken\":\"eyJ...GiftCard AcctToken...\",\r\n \"ProfileToken\":\"eyJ...Gift Card ProfileToken...\"\r\n },\r\n {\r\n \"PaymentMethodType\":\"PreferredOnFile\",\r\n \"PaymentAmount\":\"1.00\"\r\n }\r\n ]\r\n}\r\n```\r\nJSV:\r\n```jsv\r\n[{PaymentMethodType:AcctToken,PaymentAmount:1.00,AcctToken:eyj...,ProfileToken:eyJ...},{PaymentMethodType:PreferredOnFile,PaymentAmount:1.00}]\r\n```\r\n\r\nNotes: \r\n\r\n* The example shows PaymentAmount of 1.00 for both \"AcctToken\" and \"PreferredOnFile\". This is for the example\r\nwith a total of $1.00. The firstPaymentMethod (the Gift Card) will be attempted for $1.00. If it partially approves\r\nfor less than 1.00 (example: $0.80), the second payment method (PreferredOnFile) will be attempted for the lesser of\r\nit's PaymentAmount and the remaining amount (example: $0.20).\r\n\r\n* Because this endpoint creates a new user, the \"PreferredOnFile\" option is not applicable. Also, ProfileToken with\r\nthe OwnerType \"TempstUser\" is required because the Payment Profile owner will be converted to the newly created user.\r\n\r\n* 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).\r\nBasic steps to convert JSON to JSV: 1) Remove properties that are null, 2) Remove white space including line feeds, 3) Remove quotes.\r\n")
var PaymentMethods:ArrayList<PaymentMethodDto> = ArrayList<PaymentMethodDto>()
var RestrictedId:Int? = null
var RestrictedResourceType:RestrictedResourceType? = null
/**
* **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.
*/
@ApiMember(Description="\r\n**Deprecated** (Use `PaymentMethods` with `ProfileToken`) \r\n\r\nAcctToken provided by creating a Payment Profile with the Vault Api. Required if Package requires purchase and PaymentMethods is empty.")
var AcctToken:String? = null
/**
* **Deprecated** (Use `PaymentMethods` with `ProfileToken`) Last 4 digits of the Payment Profile. Required with AcctToken.
*/
@ApiMember(Description="\r\n**Deprecated** (Use `PaymentMethods` with `ProfileToken`) \r\n\r\nLast 4 digits of the Payment Profile. Required with AcctToken.")
var Last4:String? = null
/**
* **Deprecated** (Use `PaymentMethods` with `ProfileToken`) 2 digit expiration month. **Required with AcctToken for Credit Card.**
*/
@ApiMember(Description="\r\n**Deprecated** (Use `PaymentMethods` with `ProfileToken`) \r\n\r\n2 digit expiration month. **Required with AcctToken for Credit Card.**")
var ExpMonth:Int? = null
/**
* **Deprecated** (Use `PaymentMethods` with `ProfileToken`) 2 digit expiration year. **Required with AcctToken for Credit Card.**
*/
@ApiMember(Description="\r\n**Deprecated** (Use `PaymentMethods` with `ProfileToken`) \r\n\r\n2 digit expiration year. **Required with AcctToken for Credit Card.**")
var ExpYear:Int? = null
/**
* **Deprecated** (Use `PaymentMethods` with `ProfileToken`) The Account Type the Payment Profile<details><summary>Common Values</summary><table> <thead> <tr><th>Text</th><th>Numerical</th><th>Account Type</th></tr> </thead> <tbody> <tr><td>VISA</td><td>1</td><td>Visa</td></tr> <tr><td>MC</td><td>2</td><td>MasterCard</td></tr> <tr><td>Disc</td><td>3</td><td>Discover</td></tr> <tr><td>Amex</td><td>4</td><td>American Express</td></tr> <tr><td>PC</td><td>11</td><td>Personal Checking</td></tr> <tr><td>PS</td><td>12</td><td>Personal Savings</td></tr> <tr><td>BC</td><td>13</td><td>Business Checking</td></tr> </tbody></table><p>You may use the Text or the Numerical value.</p></details>
*/
@ApiMember(Description="\r\n**Deprecated** (Use `PaymentMethods` with `ProfileToken`) \r\n\r\nThe Account Type the Payment Profile\r\n\r\n<details>\r\n<summary>Common Values</summary>\r\n<table>\r\n <thead>\r\n <tr><th>Text</th><th>Numerical</th><th>Account Type</th></tr>\r\n </thead>\r\n <tbody>\r\n <tr><td>VISA</td><td>1</td><td>Visa</td></tr>\r\n <tr><td>MC</td><td>2</td><td>MasterCard</td></tr>\r\n <tr><td>Disc</td><td>3</td><td>Discover</td></tr>\r\n <tr><td>Amex</td><td>4</td><td>American Express</td></tr>\r\n <tr><td>PC</td><td>11</td><td>Personal Checking</td></tr>\r\n <tr><td>PS</td><td>12</td><td>Personal Savings</td></tr>\r\n <tr><td>BC</td><td>13</td><td>Business Checking</td></tr>\r\n </tbody>\r\n</table>\r\n<p>You may use the Text or the Numerical value.</p>\r\n</details>")
var AcctType:AcctType? = null
/**
* **Deprecated** (Use `PaymentMethods` with `ProfileToken`) Bank Routing Number. **Required with AcctToken for Bank Accounts.**
*/
@ApiMember(Description="\r\n**Deprecated** (Use `PaymentMethods` with `ProfileToken`) \r\n\r\nBank Routing Number. **Required with AcctToken for Bank Accounts.**")
var BnkRoute:Int? = null
/**
* **Deprecated** (Use `PaymentMethods` with `ProfileToken`) Whether the Payment Profile is Temporary. (One time transactions and Gift Cards are IsTemp = True).
*/
@ApiMember(Description="\r\n**Deprecated** (Use `PaymentMethods` with `ProfileToken`) \r\n\r\nWhether the Payment Profile is Temporary. (One time transactions and Gift Cards are IsTemp = True).")
var IsTemp:Boolean? = null
}
open class SellContractAndSetupClientDto : ApiDtoBase()
{
var AcctToken:String? = null
var Last4:String? = null
var ExpMonth:Int? = null
var ExpYear:Int? = null
var AcctType:AcctType? = null
var BnkRoute:Int? = null
var IsTemp:Boolean? = null
var PackageId:Int? = null
var InstallmentPlanId:Int? = null
var PaymentAmount:BigDecimal? = null
var StartDate:Date? = null
var FirstName:String? = null
var LastName:String? = null
var Address:String? = null
var City:String? = null
var State:String? = null
var Zip:String? = null
var Email:String? = null
var Gender:String? = null
var Phone:String? = null
var WorkPhone:String? = null
var DateOfBirth:Date? = null
var CellPhone:String? = null
var Note:String? = null
var ExternalId:String? = null
var PromoCode:String? = null
var Username:String? = null
var ReferralTypeId:Int? = null
var EmergencyContactName:String? = null
var EmergencyContactPhone:String? = null
var EmergencyContactType:String? = null
var PaymentMethods:ArrayList<PaymentMethodDto> = ArrayList<PaymentMethodDto>()
}
open class ApiDtoBase
{
var ApiKey:String? = null
var StoreId:Int? = null
var ChainId:Int? = null
}
@DataContract
enum class AcctType(val value:Int)
{
Uninitialized(0),
Visa(1),
Mc(2),
Disc(3),
Amex(4),
Diners(5),
Jcb(6),
EnRoute(7),
PayPal(8),
BillMe(9),
Pc(11),
Ps(12),
Bc(13),
Bs(14),
Becs(15),
Bacs(16),
Maestro(20),
Solo(21),
VisaElectron(22),
Cibc(23),
RoyalBankCa(24),
TdCaTrust(25),
Scotia(26),
Bmo(27),
HsbcCa(28),
UnionPay(29),
InterPayment(30),
Laser(31),
UnknownCredit(40),
TransArmor(41),
Factor4(42),
XPass(43),
ConnectedAccount(44),
UnknownBank(45),
Error(-1),
}
@DataContract
open class PaymentMethodDto
{
@DataMember
var AcctToken:String? = null
@DataMember
var ProfileToken:String? = null
@DataMember
var PaymentProfileId:String? = null
@DataMember
var PaymentAmount:BigDecimal? = null
@DataMember
var PaymentMethodType:PaymentMethodType? = null
@DataMember
var DoNotUpdatePaymentTypePreference:Boolean? = null
}
enum class PaymentMethodType(val value:Int)
{
Uninitialized(0),
PaymentProfileId(1),
PreferredOnFile(2),
AcctToken(3),
Error(-1),
}
enum class RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
Kotlin SellContractAndSetupClientRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"ApiKey":"String","ChainId":0,"StoreId":0,"PackageId":0,"InstallmentPlanId":0,"PaymentAmount":0,"StartDate":"0001-01-01T00:00:00.0000000","FirstName":"String","LastName":"String","Email":"String","Gender":"String","Address":"String","City":"String","State":"String","Zip":"String","Phone":"String","WorkPhone":"String","DateOfBirth":"0001-01-01T00:00:00.0000000","CellPhone":"String","Note":"String","ExternalId":"String","PromoCode":"String","Username":"String","ReferralTypeId":0,"EmergencyContactName":"String","EmergencyContactPhone":"String","EmergencyContactType":"String","PaymentMethods":[{"AcctToken":"String","ProfileToken":"String","PaymentProfileId":"String","PaymentAmount":0,"PaymentMethodType":"Uninitialized","DoNotUpdatePaymentTypePreference":false}],"RestrictedId":0,"RestrictedResourceType":"Chain","AuthToken":"String","AcctToken":"String","Last4":"String","ExpMonth":0,"ExpYear":0,"AcctType":"Uninitialized","CardType":0,"BnkRoute":0,"IsTemp":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{}