| 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. |
|---|
export class PaymentProfileBalanceInquiryRequest
{
public TerminalIpAddress: string;
public AcctToken: string;
public ProfileToken: string;
public StoreId: number;
public constructor(init?: Partial<PaymentProfileBalanceInquiryRequest>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="Looks up the balance of a payment profile created by the Vault API", ResponseType="typeof(ClubReady.Payments.PaymentProfileBalanceInquiryResponse)", StatusCode=200)
export class PaymentProfileBalanceInquiryEndpoint extends PaymentProfileBalanceInquiryRequest implements IApiKeyEndpoint
{
/**
* Api Authentication Key
*/
// @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
public ApiKey: string;
/**
* Store Id
*/
// @ApiMember(Description="Store Id", IsRequired=true, ParameterType="query")
public StoreId: number;
/**
* 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)
public AcctToken: string;
/**
* 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.")
public ProfileToken: string;
public constructor(init?: Partial<PaymentProfileBalanceInquiryEndpoint>) { super(init); (Object as any).assign(this, init); }
}
export class PamentProfileBalanceInquiryEndpointResponse
{
public Success: boolean;
public Last4: string;
public AccountBalance?: number;
public ResponseCode: string;
public Message: string;
public constructor(init?: Partial<PamentProfileBalanceInquiryEndpointResponse>) { (Object as any).assign(this, init); }
}
TypeScript PaymentProfileBalanceInquiryEndpoint DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Last4: String,
AccountBalance: 0,
ResponseCode: String,
Message: String
}