| 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. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@ApiResponse(Description="Looks up the balance of a payment profile created by the Vault API", ResponseType=PaymentProfileBalanceInquiryResponse.class, StatusCode=200)
open class PaymentProfileBalanceInquiryEndpoint : PaymentProfileBalanceInquiryRequest(), IApiKeyEndpoint
{
/**
* Api Authentication Key
*/
@ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
var ApiKey:String? = null
/**
* Store Id
*/
@ApiMember(Description="Store Id", IsRequired=true, ParameterType="query")
var StoreId:Int? = null
/**
* 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.
*/
@ApiMember(Description="\r\nEncoded data uniquely identifying the payment profile. \r\nLong term storage of AcctToken is not recommended, as the token may change over time (for example, by processes like Account Updater). \r\nThe length is usually 80 characters.", IsRequired=true)
var AcctToken:String? = null
/**
* 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 timevalidation is to prevent old tokens from be re-played at a later time. The length is variable, but generally around 1,000 characters.
*/
@ApiMember(Description="\r\nEncoded data containing non-PCI information about the Payment Profile. \r\n\r\nProfileTokens contain a timestamp. If the ClubReady API does not process the token within 5 minutes,\r\nit cannot be accepted and a new profile will have to be created with a new AcctToken. The time\r\nvalidation is to prevent old tokens from be re-played at a later time. \r\n\r\nThe length is variable, but generally around 1,000 characters.")
var ProfileToken:String? = null
}
open class PaymentProfileBalanceInquiryRequest
{
var TerminalIpAddress:String? = null
var AcctToken:String? = null
var ProfileToken:String? = null
var StoreId:Int? = null
}
open class PamentProfileBalanceInquiryEndpointResponse
{
var Success:Boolean? = null
var Last4:String? = null
var AccountBalance:BigDecimal? = null
var ResponseCode:String? = null
var Message:String? = null
}
Kotlin PaymentProfileBalanceInquiryEndpoint DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>