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
MakePayment Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesID # of store member belongs to
ChainIdqueryintegerNoID # of chain member belongs to
MemberIdpathintegerYesMember ID of user to make payment for
AmountquerydecimalYesAmount of the payment, including sales tax
InvoicequeryintegerYesInvoice ID to be paid
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
MakePaymentRequest Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
AmountformdecimalNo
Invoiceformint[]No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
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/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>