ClubReady Api

<back to all web services

MakePayment

The following routes are available for this service:
POST/sales/member/{MemberId}/payment/makepaymentMake a Payment for a Member
import java.math.*
import java.util.*
import net.servicestack.client.*


open class MakePayment : MakePaymentRequest(), IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * ID # of store member belongs to
    */
    @ApiMember(DataType="integer", Description="ID # of store member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * ID # of chain member belongs to
    */
    @ApiMember(DataType="integer", Description="ID # of chain member belongs to", Name="ChainId", ParameterType="query")
    var ChainId:Int? = null

    /**
    * Member ID of user to make payment for
    */
    @ApiMember(DataType="integer", Description="Member ID of user to make payment for", IsRequired=true, Name="MemberId", ParameterType="path")
    var MemberId:Int? = null

    /**
    * Amount of the payment, including sales tax
    */
    @ApiMember(DataType="decimal", Description="Amount of the payment, including sales tax", IsRequired=true, Name="Amount", ParameterType="query")
    var Amount:BigDecimal? = null

    /**
    * Invoice ID to be paid
    */
    @ApiMember(DataType="integer", Description="Invoice ID to be paid", IsRequired=true, Name="Invoice", ParameterType="query")
    var Invoice:ArrayList<Int>? = null

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

open class MakePaymentRequest : ApiDtoBase()
{
    var UserId:Int? = null
    var Amount:BigDecimal? = null
    var Invoice:ArrayList<Int>? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

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

Kotlin MakePayment 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/makepayment HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MakePayment 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>
  <Amount xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</Amount>
  <Invoice xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:int>0</d2p1:int>
  </Invoice>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
  <MemberId>0</MemberId>
</MakePayment>