ClubReady Api

MakePayment

The following routes are available for this service:
POST	/sales/member/{MemberId}/payment/makepayment	Make a Payment for a Member

**MakePayment** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	No	IP address of the end user
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	Yes	ID # of store member belongs to
ChainId	query	integer	No	ID # of chain member belongs to
MemberId	path	integer	Yes	Member ID of user to make payment for
Amount	query	decimal	Yes	Amount of the payment, including sales tax
Invoice	query	integer	Yes	Invoice ID to be paid
RestrictedId	body	int?	No
RestrictedResourceType	body	RestrictedResourceType	No

**MakePaymentRequest** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
Amount	form	decimal	No
Invoice	form	int[]	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**MakePaymentResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Message	form	string	No
PaymentId	form	int?	No

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: www.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">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">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>
  <XForwardedFor>String</XForwardedFor>
</MakePayment>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MakePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
  <Message>String</Message>
  <PaymentId>0</PaymentId>
  <Success>false</Success>
</MakePaymentResponse>