ClubReady Api

PaymentProfileBalanceInquiryEndpoint

The following routes are available for this service:
GET	/sales/paymentProfile/balanceInquiry	Look up Factor 4 gift card balance	This endpoint has two inquiry styles. If only the AcctToken is provided, it can look up balance of a factor4 gift card that has already been imported into ClubReady. If both PaymentProfile and AcctToken are provided, this endpoint will add the profile to the user before looking up the balance. If you provide both parameters, a separate call to 'sales/paymentProfile/import' is unnecessary. The AcctToken and ProfileToken are created by the ClubReadyGateway API.

**PaymentProfileBalanceInquiryEndpoint** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	query	string	Yes	Api Authentication Key
StoreId	query	int	Yes	Store Id
AcctToken	query	string	Yes	Encoded data uniquely identifying the payment profile. Long term storage of AcctToken is not recommended, as the token may change over time (for example, by processes like Account Updater). The length is usually 80 characters.
ProfileToken	query	string	No	Encoded data containing non-PCI information about the Payment Profile. ProfileTokens contain a timestamp. If the ClubReady API does not process the token within 5 minutes, it cannot be accepted and a new profile will have to be created with a new AcctToken. The time validation is to prevent old tokens from be re-played at a later time. The length is variable, but generally around 1,000 characters.

**PaymentProfileBalanceInquiryRequest** Parameters:
Name	Parameter	Data Type	Required
TerminalIpAddress	form	string	No
AcctToken	form	string	No
ProfileToken	form	string	No
StoreId	form	int	No

**PamentProfileBalanceInquiryEndpointResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Last4	form	string	No
AccountBalance	form	decimal?	No
ResponseCode	form	string	No
Message	form	string	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.

GET /sales/paymentProfile/balanceInquiry HTTP/1.1 
Host: clubready.com 
Accept: application/xml

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

<PamentProfileBalanceInquiryEndpointResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.Model">
  <AccountBalance>0</AccountBalance>
  <Last4>String</Last4>
  <Message>String</Message>
  <ResponseCode>String</ResponseCode>
  <Success>false</Success>
</PamentProfileBalanceInquiryEndpointResponse>