| 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.*;
public class dtos
{
@ApiResponse(Description="", ResponseType=SellContractAndSetupClientResponse.class, StatusCode=200)
public static class SellContractAndSetupClientRequest extends SellContractAndSetupClientDto implements IRestrictedApiRequest
{
/**
* Api Authentication Key
*/
@ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
public String ApiKey = null;
/**
* Id for the chain of the Api Key
*/
@ApiMember(Description="Id for the chain of the Api Key", ParameterType="query")
public Integer ChainId = null;
/**
* Id of the store for the user
*/
@ApiMember(Description="Id of the store for the user", IsRequired=true, ParameterType="query")
public Integer StoreId = null;
/**
* Package Id being sold
*/
@ApiMember(Description="Package Id being sold", IsRequired=true)
public Integer PackageId = null;
/**
* Installment Plan Id being sold
*/
@ApiMember(Description="Installment Plan Id being sold", IsRequired=true)
public Integer InstallmentPlanId = null;
/**
* Amount being paid
*/
@ApiMember(Description="Amount being paid", IsRequired=true)
public BigDecimal PaymentAmount = null;
/**
* Date contract takes affect
*/
@ApiMember(Description="Date contract takes affect")
public Date StartDate = null;
/**
* First Name
*/
@ApiMember(Description="First Name", IsRequired=true)
public String FirstName = null;
/**
* Last Name
*/
@ApiMember(Description="Last Name", IsRequired=true)
public String LastName = null;
/**
* Email Address
*/
@ApiMember(Description="Email Address", IsRequired=true)
public String Email = null;
/**
* Gender
*/
@ApiMember(Description="Gender")
public String Gender = null;
/**
* Address
*/
@ApiMember(Description="Address")
public String Address = null;
/**
* City
*/
@ApiMember(Description="City")
public String City = null;
/**
* State
*/
@ApiMember(Description="State")
public String State = null;
/**
* Zip Code
*/
@ApiMember(Description="Zip Code")
public String Zip = null;
/**
* Home phone
*/
@ApiMember(Description="Home phone")
public String Phone = null;
/**
* Work phone
*/
@ApiMember(Description="Work phone")
public String WorkPhone = null;
/**
* Date of Birth
*/
@ApiMember(Description="Date of Birth")
public Date DateOfBirth = null;
/**
* Cell phone
*/
@ApiMember(Description="Cell phone")
public String CellPhone = null;
/**
* Add an internal note for the new prospect
*/
@ApiMember(Description="Add an internal note for the new prospect")
public String Note = 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")
public String ExternalId = null;
/**
* Promo code to apply a discount.
*/
@ApiMember(Description="Promo code to apply a discount.")
public String PromoCode = null;
/**
* Username should be between 4 and 255 characters long
*/
@ApiMember(Description="Username should be between 4 and 255 characters long")
public String Username = null;
/**
* ReferralTypeId
*/
@ApiMember(Description="ReferralTypeId")
public Integer ReferralTypeId = null;
/**
* Emergency contact name
*/
@ApiMember(Description="Emergency contact name")
public String EmergencyContactName = null;
/**
* Emergency contact phone number
*/
@ApiMember(Description="Emergency contact phone number")
public String EmergencyContactPhone = null;
/**
* Emergency contact relationship
*/
@ApiMember(Description="Emergency contact relationship")
public String EmergencyContactType = 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")
public ArrayList<PaymentMethodDto> PaymentMethods = null;
public Integer RestrictedId = null;
public 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.")
public String AcctToken = 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.")
public String Last4 = 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.**")
public Integer ExpMonth = 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.**")
public Integer ExpYear = 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>")
public 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.**")
public Integer BnkRoute = 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).")
public Boolean IsTemp = null;
public String getApiKey() { return ApiKey; }
public SellContractAndSetupClientRequest setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getChainId() { return ChainId; }
public SellContractAndSetupClientRequest setChainId(Integer value) { this.ChainId = value; return this; }
public Integer getStoreId() { return StoreId; }
public SellContractAndSetupClientRequest setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getPackageId() { return PackageId; }
public SellContractAndSetupClientRequest setPackageId(Integer value) { this.PackageId = value; return this; }
public Integer getInstallmentPlanId() { return InstallmentPlanId; }
public SellContractAndSetupClientRequest setInstallmentPlanId(Integer value) { this.InstallmentPlanId = value; return this; }
public BigDecimal getPaymentAmount() { return PaymentAmount; }
public SellContractAndSetupClientRequest setPaymentAmount(BigDecimal value) { this.PaymentAmount = value; return this; }
public Date getStartDate() { return StartDate; }
public SellContractAndSetupClientRequest setStartDate(Date value) { this.StartDate = value; return this; }
public String getFirstName() { return FirstName; }
public SellContractAndSetupClientRequest setFirstName(String value) { this.FirstName = value; return this; }
public String getLastName() { return LastName; }
public SellContractAndSetupClientRequest setLastName(String value) { this.LastName = value; return this; }
public String getEmail() { return Email; }
public SellContractAndSetupClientRequest setEmail(String value) { this.Email = value; return this; }
public String getGender() { return Gender; }
public SellContractAndSetupClientRequest setGender(String value) { this.Gender = value; return this; }
public String getAddress() { return Address; }
public SellContractAndSetupClientRequest setAddress(String value) { this.Address = value; return this; }
public String getCity() { return City; }
public SellContractAndSetupClientRequest setCity(String value) { this.City = value; return this; }
public String getState() { return State; }
public SellContractAndSetupClientRequest setState(String value) { this.State = value; return this; }
public String getZip() { return Zip; }
public SellContractAndSetupClientRequest setZip(String value) { this.Zip = value; return this; }
public String getPhone() { return Phone; }
public SellContractAndSetupClientRequest setPhone(String value) { this.Phone = value; return this; }
public String getWorkPhone() { return WorkPhone; }
public SellContractAndSetupClientRequest setWorkPhone(String value) { this.WorkPhone = value; return this; }
public Date getDateOfBirth() { return DateOfBirth; }
public SellContractAndSetupClientRequest setDateOfBirth(Date value) { this.DateOfBirth = value; return this; }
public String getCellPhone() { return CellPhone; }
public SellContractAndSetupClientRequest setCellPhone(String value) { this.CellPhone = value; return this; }
public String getNote() { return Note; }
public SellContractAndSetupClientRequest setNote(String value) { this.Note = value; return this; }
public String getExternalId() { return ExternalId; }
public SellContractAndSetupClientRequest setExternalId(String value) { this.ExternalId = value; return this; }
public String getPromoCode() { return PromoCode; }
public SellContractAndSetupClientRequest setPromoCode(String value) { this.PromoCode = value; return this; }
public String getUsername() { return Username; }
public SellContractAndSetupClientRequest setUsername(String value) { this.Username = value; return this; }
public Integer getReferralTypeId() { return ReferralTypeId; }
public SellContractAndSetupClientRequest setReferralTypeId(Integer value) { this.ReferralTypeId = value; return this; }
public String getEmergencyContactName() { return EmergencyContactName; }
public SellContractAndSetupClientRequest setEmergencyContactName(String value) { this.EmergencyContactName = value; return this; }
public String getEmergencyContactPhone() { return EmergencyContactPhone; }
public SellContractAndSetupClientRequest setEmergencyContactPhone(String value) { this.EmergencyContactPhone = value; return this; }
public String getEmergencyContactType() { return EmergencyContactType; }
public SellContractAndSetupClientRequest setEmergencyContactType(String value) { this.EmergencyContactType = value; return this; }
public ArrayList<PaymentMethodDto> getPaymentMethods() { return PaymentMethods; }
public SellContractAndSetupClientRequest setPaymentMethods(ArrayList<PaymentMethodDto> value) { this.PaymentMethods = value; return this; }
public Integer getRestrictedId() { return RestrictedId; }
public SellContractAndSetupClientRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
public SellContractAndSetupClientRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
public String getAcctToken() { return AcctToken; }
public SellContractAndSetupClientRequest setAcctToken(String value) { this.AcctToken = value; return this; }
public String getLast4() { return Last4; }
public SellContractAndSetupClientRequest setLast4(String value) { this.Last4 = value; return this; }
public Integer getExpMonth() { return ExpMonth; }
public SellContractAndSetupClientRequest setExpMonth(Integer value) { this.ExpMonth = value; return this; }
public Integer getExpYear() { return ExpYear; }
public SellContractAndSetupClientRequest setExpYear(Integer value) { this.ExpYear = value; return this; }
public AcctType getAcctType() { return AcctType; }
public SellContractAndSetupClientRequest setAcctType(AcctType value) { this.AcctType = value; return this; }
public Integer getBnkRoute() { return BnkRoute; }
public SellContractAndSetupClientRequest setBnkRoute(Integer value) { this.BnkRoute = value; return this; }
public Boolean getIsTemp() { return IsTemp; }
public SellContractAndSetupClientRequest setIsTemp(Boolean value) { this.IsTemp = value; return this; }
}
public static class SellContractAndSetupClientDto extends ApiDtoBase
{
public String AcctToken = null;
public String Last4 = null;
public Integer ExpMonth = null;
public Integer ExpYear = null;
public AcctType AcctType = null;
public Integer BnkRoute = null;
public Boolean IsTemp = null;
public Integer PackageId = null;
public Integer InstallmentPlanId = null;
public BigDecimal PaymentAmount = null;
public Date StartDate = null;
public String FirstName = null;
public String LastName = null;
public String Address = null;
public String City = null;
public String State = null;
public String Zip = null;
public String Email = null;
public String Gender = null;
public String Phone = null;
public String WorkPhone = null;
public Date DateOfBirth = null;
public String CellPhone = null;
public String Note = null;
public String ExternalId = null;
public String PromoCode = null;
public String Username = null;
public Integer ReferralTypeId = null;
public String EmergencyContactName = null;
public String EmergencyContactPhone = null;
public String EmergencyContactType = null;
public ArrayList<PaymentMethodDto> PaymentMethods = null;
public String getAcctToken() { return AcctToken; }
public SellContractAndSetupClientDto setAcctToken(String value) { this.AcctToken = value; return this; }
public String getLast4() { return Last4; }
public SellContractAndSetupClientDto setLast4(String value) { this.Last4 = value; return this; }
public Integer getExpMonth() { return ExpMonth; }
public SellContractAndSetupClientDto setExpMonth(Integer value) { this.ExpMonth = value; return this; }
public Integer getExpYear() { return ExpYear; }
public SellContractAndSetupClientDto setExpYear(Integer value) { this.ExpYear = value; return this; }
public AcctType getAcctType() { return AcctType; }
public SellContractAndSetupClientDto setAcctType(AcctType value) { this.AcctType = value; return this; }
public Integer getBnkRoute() { return BnkRoute; }
public SellContractAndSetupClientDto setBnkRoute(Integer value) { this.BnkRoute = value; return this; }
public Boolean getIsTemp() { return IsTemp; }
public SellContractAndSetupClientDto setIsTemp(Boolean value) { this.IsTemp = value; return this; }
public Integer getPackageId() { return PackageId; }
public SellContractAndSetupClientDto setPackageId(Integer value) { this.PackageId = value; return this; }
public Integer getInstallmentPlanId() { return InstallmentPlanId; }
public SellContractAndSetupClientDto setInstallmentPlanId(Integer value) { this.InstallmentPlanId = value; return this; }
public BigDecimal getPaymentAmount() { return PaymentAmount; }
public SellContractAndSetupClientDto setPaymentAmount(BigDecimal value) { this.PaymentAmount = value; return this; }
public Date getStartDate() { return StartDate; }
public SellContractAndSetupClientDto setStartDate(Date value) { this.StartDate = value; return this; }
public String getFirstName() { return FirstName; }
public SellContractAndSetupClientDto setFirstName(String value) { this.FirstName = value; return this; }
public String getLastName() { return LastName; }
public SellContractAndSetupClientDto setLastName(String value) { this.LastName = value; return this; }
public String getAddress() { return Address; }
public SellContractAndSetupClientDto setAddress(String value) { this.Address = value; return this; }
public String getCity() { return City; }
public SellContractAndSetupClientDto setCity(String value) { this.City = value; return this; }
public String getState() { return State; }
public SellContractAndSetupClientDto setState(String value) { this.State = value; return this; }
public String getZip() { return Zip; }
public SellContractAndSetupClientDto setZip(String value) { this.Zip = value; return this; }
public String getEmail() { return Email; }
public SellContractAndSetupClientDto setEmail(String value) { this.Email = value; return this; }
public String getGender() { return Gender; }
public SellContractAndSetupClientDto setGender(String value) { this.Gender = value; return this; }
public String getPhone() { return Phone; }
public SellContractAndSetupClientDto setPhone(String value) { this.Phone = value; return this; }
public String getWorkPhone() { return WorkPhone; }
public SellContractAndSetupClientDto setWorkPhone(String value) { this.WorkPhone = value; return this; }
public Date getDateOfBirth() { return DateOfBirth; }
public SellContractAndSetupClientDto setDateOfBirth(Date value) { this.DateOfBirth = value; return this; }
public String getCellPhone() { return CellPhone; }
public SellContractAndSetupClientDto setCellPhone(String value) { this.CellPhone = value; return this; }
public String getNote() { return Note; }
public SellContractAndSetupClientDto setNote(String value) { this.Note = value; return this; }
public String getExternalId() { return ExternalId; }
public SellContractAndSetupClientDto setExternalId(String value) { this.ExternalId = value; return this; }
public String getPromoCode() { return PromoCode; }
public SellContractAndSetupClientDto setPromoCode(String value) { this.PromoCode = value; return this; }
public String getUsername() { return Username; }
public SellContractAndSetupClientDto setUsername(String value) { this.Username = value; return this; }
public Integer getReferralTypeId() { return ReferralTypeId; }
public SellContractAndSetupClientDto setReferralTypeId(Integer value) { this.ReferralTypeId = value; return this; }
public String getEmergencyContactName() { return EmergencyContactName; }
public SellContractAndSetupClientDto setEmergencyContactName(String value) { this.EmergencyContactName = value; return this; }
public String getEmergencyContactPhone() { return EmergencyContactPhone; }
public SellContractAndSetupClientDto setEmergencyContactPhone(String value) { this.EmergencyContactPhone = value; return this; }
public String getEmergencyContactType() { return EmergencyContactType; }
public SellContractAndSetupClientDto setEmergencyContactType(String value) { this.EmergencyContactType = value; return this; }
public ArrayList<PaymentMethodDto> getPaymentMethods() { return PaymentMethods; }
public SellContractAndSetupClientDto setPaymentMethods(ArrayList<PaymentMethodDto> value) { this.PaymentMethods = value; return this; }
}
public static class ApiDtoBase
{
public String ApiKey = null;
public Integer StoreId = null;
public Integer ChainId = null;
public String getApiKey() { return ApiKey; }
public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getStoreId() { return StoreId; }
public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getChainId() { return ChainId; }
public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
}
@DataContract
public static enum AcctType
{
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);
private final int value;
AcctType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
@DataContract
public static class PaymentMethodDto
{
@DataMember
public String AcctToken = null;
@DataMember
public String ProfileToken = null;
@DataMember
public String PaymentProfileId = null;
@DataMember
public BigDecimal PaymentAmount = null;
@DataMember
public PaymentMethodType PaymentMethodType = null;
@DataMember
public Boolean DoNotUpdatePaymentTypePreference = null;
public String getAcctToken() { return AcctToken; }
public PaymentMethodDto setAcctToken(String value) { this.AcctToken = value; return this; }
public String getProfileToken() { return ProfileToken; }
public PaymentMethodDto setProfileToken(String value) { this.ProfileToken = value; return this; }
public String getPaymentProfileId() { return PaymentProfileId; }
public PaymentMethodDto setPaymentProfileId(String value) { this.PaymentProfileId = value; return this; }
public BigDecimal getPaymentAmount() { return PaymentAmount; }
public PaymentMethodDto setPaymentAmount(BigDecimal value) { this.PaymentAmount = value; return this; }
public PaymentMethodType getPaymentMethodType() { return PaymentMethodType; }
public PaymentMethodDto setPaymentMethodType(PaymentMethodType value) { this.PaymentMethodType = value; return this; }
public Boolean isDoNotUpdatePaymentTypePreference() { return DoNotUpdatePaymentTypePreference; }
public PaymentMethodDto setDoNotUpdatePaymentTypePreference(Boolean value) { this.DoNotUpdatePaymentTypePreference = value; return this; }
}
public static enum PaymentMethodType
{
Uninitialized(0),
PaymentProfileId(1),
PreferredOnFile(2),
AcctToken(3),
Error(-1);
private final int value;
PaymentMethodType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined;
}
}
Java SellContractAndSetupClientRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: String,
ChainId: 0,
StoreId: 0,
PackageId: 0,
InstallmentPlanId: 0,
PaymentAmount: 0,
StartDate: 0001-01-01,
FirstName: String,
LastName: String,
Email: String,
Gender: String,
Address: String,
City: String,
State: String,
Zip: String,
Phone: String,
WorkPhone: String,
DateOfBirth: 0001-01-01,
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: text/jsv
Content-Length: length
{
}