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
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="", ResponseType=AddPaymentProfileResponse.class, StatusCode=200)
open class AddPaymentAccount : AddPaymentProfileRequest(), IRestrictedApiRequest
{
    /**
    * Api Authentication Key
    */
    @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
    var ApiKey:String? = 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

    /**
    * Member Id of the user to update their Payment Profile
    */
    @ApiMember(Description="Member Id of the user to update their Payment Profile", IsRequired=true, ParameterType="path")
    var MemberId:Int? = null

    /**
    * The AcctToken provided by creating a Payment Profile with the Vault Api
    */
    @ApiMember(Description="The AcctToken provided by creating a Payment Profile with the Vault Api", IsRequired=true)
    var AcctToken:String? = null

    /**
    * Last 4 digits of the Payment Profile
    */
    @ApiMember(Description="Last 4 digits of the Payment Profile")
    var Last4:String? = null

    /**
    * 2 digit expiration month  **Required for Credit Card**
    */
    @ApiMember(Description="2 digit expiration month  \n**Required for Credit Card**")
    var ExpMonth:Int? = null

    /**
    * 2 digit expiration year  **Required for Credit Card**
    */
    @ApiMember(Description="2 digit expiration year  \n**Required for Credit Card**")
    var ExpYear:Int? = null

    /**
    * The Account Type of the Payment Profile  **Required when adding Gift Card**<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>        <tr><td>Factor4</td><td>42</td><td>Factor4 Gift Card</td></tr>    </tbody></table><p>You may use the Text or the Numerical value.</p></details>
    */
    @ApiMember(Description="\r\nThe Account Type of the Payment Profile  \r\n**Required when adding Gift Card**\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        <tr><td>Factor4</td><td>42</td><td>Factor4 Gift Card</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

    /**
    * Bank Routing Number  **Required for Bank Accounts**
    */
    @ApiMember(Description="Bank Routing Number  \n**Required for Bank Accounts**")
    var BnkRoute:Int? = null

    /**
    * Set to `true` to not set the user's Payment Type Preference when adding an on-file profile
    */
    @ApiMember(Description="Set to `true` to not set the user's Payment Type Preference when adding an on-file profile")
    var DoNotUpdatePaymentTypePreference:Boolean? = null

    /**
    * Whether the Payment Profile is Temporary (One time transactions and Gift Cards are IsTemp = `true`)
    */
    @ApiMember(Description="Whether the Payment Profile is Temporary (One time transactions and Gift Cards are IsTemp = `true`)")
    var IsTemp:Boolean? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class AddPaymentProfileRequest : ApiDtoBase()
{
    var UserId:Int? = null
    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 FirstName:String? = null
    var MiddleName:String? = null
    var LastName:String? = null
    var Address1:String? = null
    var Address2:String? = null
    var City:String? = null
    var State:String? = null
    var PostalCode:String? = null
    var CountryCode:String? = null
    var Urbanization:String? = null
    var DoNotUpdatePaymentTypePreference:Boolean? = null
    var IsTemp:Boolean? = null
}

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),
    Error(-1),
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open class AddPaymentProfileResponse
{
    var Success:String? = null
    var Message:String? = null
}

Kotlin AddPaymentAccount DTOs

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: www.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>