Balance Inquiry
Request to retrieve the balance available to spend on a card. You can use this operation to request: The balance available on a gift card, or The balance available to spend by redeeming rewards earned using a card enrolled in a rewards program. For gift cards, only the balance available is returned. For credit or debit cards, additional details such as the reward points available to redeem and the conversion rate used to determine the available balance are also returned.
Authentication Copied to clipboard
This operation requires authentication via one of the following methods:
- Certificate authentication.
-
Basic HTTP authentication as described at
w3.org.
Provide 'merchant.
<your gateway merchant ID>' in the userid portion and your API password in the password portion.
Request Copied to clipboard
URL Parameters Copied to clipboard
Alphanumeric + additional characters
REQUIRED
The unique identifier issued to you by your payment provider.
This identifier can be up to 12 characters in length.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Min length: 1 Max length: 40Fields Copied to clipboard
String
OPTIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
Upper case alphabetic text
REQUIRED
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
These merchants are referred to as your sub-merchants. The sub-merchant's details you provide may be displayed on the payer's cardholder statement. Note that your acquirer may require you to register with the card scheme(s) before allowing you to submit sub-merchant details with a transaction. This data must be on the initial transaction of an order, subsequent transactions with sub-merchant will be rejected.
The sub-merchant's address.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
String
OPTIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
OPTIONAL
The state or province of the address.
Data can consist of any characters
String
OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
OPTIONAL
The second line of the address (if provided).
Data can consist of any characters
Digits
OPTIONAL
Code used by acquirer to describe the business or industry the sub-merchant operates in.
Data is a string that consists of the characters 0-9.
Email
OPTIONAL
The sub-merchant's email address.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
OPTIONAL
Your identifier for the sub-merchant.
You can use this identifier in searches and reports in the gateway.
Data can consist of any characters
String
OPTIONAL
The sub-merchant's phone number
Data can consist of any characters
String
OPTIONAL
The legal name of the sub-merchant.
Data can consist of any characters
String
OPTIONAL
The trading name of the sub merchant, also known as doing business as (DBA), operating as or trading as.
For MasterCard transactions the name must not exceed 21 characters. For American Express transactions the name must not exceed 27 characters (or 36 characters including the aggregator name). The trading name may be displayed on the payer's cardholder statement. Therefore if you need to shorten it, use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Container for fields that control the response returned for the request.
String
OPTIONAL
Indicates how sensitive data is returned in the response.
Data can consist of any characters
ASCII Text
OPTIONAL
Identifier of the payment session containing values for any of the request fields to be used in this operation.
Values provided in the request will override values contained in the session.
Data consists of ASCII characters
ASCII Text
OPTIONAL
Use this field to implement optimistic locking of the session content.
Do this if you make business decisions based on data from the session and wish to ensure that the same data is being used for the request operation.
To use optimistic locking, record session.version when you make your decisions, and then pass that value in session.version when you submit your request operation to the gateway.
If session.version provided by you does not match that stored against the session, the gateway will reject the operation with error.cause=INVALID_REQUEST.
See Making Business Decisions Based on Session Content.
Data consists of ASCII characters
Information about the payment type selected by the payer for this payment and the source of the funds.
Depending on the payment type the source of the funds can be a debit or credit card, bank account, or account with a browser payment provider (such as PayPal).
For card payments the source of funds information may be represented by combining one or more of the following: explicitly provided card details, a session identifier which the gateway will use to look up the card details and/or a card token. Precedence rules will be applied in that explicitly provided card details will override session card details which will override card token details. Each of these may represent partial card details, however the combination must result in a full and complete set of card details. See Using Multiple Sources of Card Details for examples.
Information about the source of funds when it is directly provided (as opposed to via a token or session).
For browser payments, the source of funds details are usually collected from the payer on the payment provider's website and provided to you when you retrieve the transaction details (for a successful transaction). However, for some payment types (such as giropay), you must collect the information from the payer and supply it here.
Contains card details
Enumeration
OPTIONAL
Type of the bank account associated with the card.
Provide this information for Maestro cards.
Value must be a member of the following list. The values are case sensitive.
CHECKING
SAVINGS
String
OPTIONAL
This field only applies to transactions that originate from an EMV capable terminal.
It contains selected EMV fields as provided by the terminal.
For the list of field tags to include (if provided by the terminal), see Card Present Payments. Requests with any other tags are rejected by the gateway.
Some of the tags represent data that can occur on explicit fields in this API. You can submit the value either in this field, or in both places. For example, the PAN can be presented as EMV tag 5A in this field, or included both the sourceOfFunds.provided.card.number API field and in EMV tag 5A in this field.
If you specify the EMV tag only, we can populate the explicit field in the API. Fields where this is supported have the text "This field corresponds to EMV tag <tag name>" in their field descriptions.
If you specify both places, there will be no population of the explicit field or validation that the data matches.
The API response will not contain PCI sensitive fields.
Data can consist of any characters
Expiry date, as shown on the card.
This field corresponds to EMV tag 5F24
Digits
REQUIRED
Month, as shown on the card.
Months are numbered January=1, through to December=12.
Data is a number between 1 and 12 represented as a string.
Digits
REQUIRED
Year, as shown on the card.
The Common Era year is 2000 plus this value.
Data is a string that consists of the characters 0-9.
If the payer chose to pay using a mobile device you must provide details from the wallet in this parameter group.
Use this parameter group when accepting payments from mobile wallet providers such as Apple Pay, Android Pay or Samsung Pay.
Cryptogram data for mobile wallet payments provided in 3DSecure format.
Digits
OPTIONAL
The Electronic Commerce Indicator generated for the mobile wallet payment.
It indicates the level of security and authentication of the transaction.
Data is a string that consists of the characters 0-9.
Base64
REQUIRED
The unique transaction cryptogram generated for the mobile wallet payment.
This will be in Base64 format for MasterCard and Visa transactions and binary format for American Express transactions.
Data is Base64 encoded
Enumeration
REQUIRED
The format of the cryptogram provided for the device payment.
You must provide the cryptogram format when you decrypt the payment token and provide the payment details (including the online payment cryptogram) in the transaction request.
Value must be a member of the following list. The values are case sensitive.
3DSECURE
The payment data keys for the online payment cryptogram are provided using the 3-D Secure format.
EMV
The payment data keys for the online payment cryptogram are provided using the EMV format.
String
OPTIONAL
The cardholder's name as printed on the card.
Data can consist of any characters
Digits
OPTIONAL
Credit card number as printed on the card.
This field corresponds to EMV tag 5A
Data is a string that consists of the characters 0-9.
This holds the PAN in the case where it is encrypted by the terminal using DUKPT key exchange.
Digits
OPTIONAL
The BIN of the card.
If you provide this, the gateway will check that the decrypted PAN has these leading six digits. If the check fails, the gateway will reject the transaction.
If you do not provided this, the gateway will not perform this check.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The P2PE encryption state as determined by the terminal.
INVALID means the terminal detected some form of error in the encryption process. The gateway will decline transactions with INVALID encryption state. This field may be omitted when the value is VALID.
Data can consist of any characters
Hex
OPTIONAL
The initialization vector supplied by the terminal to seed the encryption of this payload.
Omit this value if the terminal is not using an initialization vector to seed encryption.
Data is hexadecimal encoded
Hex
REQUIRED
The DUKPT key serial number supplied by the terminal.
Data is hexadecimal encoded
Hex
REQUIRED
The DUKPT encrypted payload supplied by the terminal.
Data is hexadecimal encoded
The PIN (Personal Identification Number) entered by a payer at the point of sale that is used to authenticate their identity as the cardholder with the issuer.
Provide this data in the case were you want the PIN verified online by the issuer. The gateway supports PINs encoded in ISO 9564-1 formats 0, 1 and 3.
Enumeration
OPTIONAL
The PIN encryption state as determined by the terminal.
INVALID means the terminal detected some form of error in the encryption process. The gateway will decline transactions with INVALID encryption state. This field may be omitted when the value is VALID.
Value must be a member of the following list. The values are case sensitive.
INVALID
The encryption state is invalid.
VALID
The encryption state is valid.
Hex
REQUIRED
The DUKPT key serial number supplied by the terminal.
Data is hexadecimal encoded
Hex
REQUIRED
The DUKPT encrypted payload supplied by the terminal.
Data is hexadecimal encoded
Digits
OPTIONAL
Card verification code, as printed on the back or front of the card.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
A number used to differentiate between cards with the same Primary Account Number (PAN).
This field corresponds to EMV tag 5F34
Data is a number between 0 and 999 represented as a string.
Track 1 Data
OPTIONAL
This field contains the full track data.
You may optionally include the start and end sentinels and LRC.
Provide this for stripe and EMV fallback to stripe cases.
This field corresponds to EMV tag 56
Data must comply with ISO 7811-2 track 1 data character set.
Data may consist of the characters: ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ]]>
Track 2 Data
OPTIONAL
This field contains the full track data.
You may optionally include the start and end sentinels and LRC.
Provide this for stripe and EMV fallback to stripe cases.
The contents of this field must match the PAN and expiry fields included in the Transaction Request.
This field corresponds to EMV tag 57
Data must comply with ISO 7811-2 track 2 data character set.
Data may consist of the characters: ? ]]>
Contains gift card details
String
OPTIONAL
Do not provide this field in your request unless instructed to do so by your payment service provider.
The field is required, if your gift card numbers do not use ISO BIN rules and therefore not allowing the gateway to identify the local brand.
Data can consist of any characters
Digits
OPTIONAL
Card number as printed or embossed on the gift card.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
PIN number for the gift card.
Data is a string that consists of the characters 0-9.
Alphanumeric
OPTIONAL
Uniquely identifies a card and associated details.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
REQUIRED
The payment method your payer has chosen for this payment.
Value must be a member of the following list. The values are case sensitive.
CARD
The payer provided a credit or debit card as the payment method.
GIFT_CARD
The payer provided a gift card as the payment method.
Response Copied to clipboard
Fields Copied to clipboard
Decimal
CONDITIONAL
The amount available to spend on a gift card.
Data is a decimal number.
Upper case alphabetic text
CONDITIONAL
The currency of available balance on the gift card expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
Decimal
ALWAYS PROVIDED
The amount available to spend by redeeming rewards available for the card.
This amount is the rewards points available for the card (availableBalance.reward.points) divided by the conversion rate (availableBalance.reward.conversionRate). For example, if the payer has 1500 points available and the conversion rate is 10 then the currency equivalent amount is 150.
Data is a decimal number.
Decimal
ALWAYS PROVIDED
The factor used to convert rewards points (availableBalance.reward.points) to an amount available to spend (availableBalance.reward.amount).
For example, if the payer has 1500 points available and the conversion rate is 10 then the currency equivalent amount is 150.
Data is a decimal number.
Upper case alphabetic text
ALWAYS PROVIDED
The currency of the reward amount (availableBalance.reward.amount).
Expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
Decimal
ALWAYS PROVIDED
The rewards program allows the payer to redeem points for purchases that are above the minimum spend amount (availableBalance.reward.minimumSpendAmount) and below the maximum spend amount (availableBalance.reward.maximumSpendAmount) in multiples of a specific additional amount.
This additional amount is the incremental spend amount. For example, if the minimum spend amount is $100, the maximum spend amount is $500, and the incremental spend amount is $20, then the payer can redeem points for purchases between $100 and $500 in increments of $20. If the purchase is for $155 they can redeem $140 from rewards points and will need to pay the balance of $15 on their card.
Data is a decimal number.
Decimal
ALWAYS PROVIDED
The maximum amount the payer can spend to redeem points for a purchase.
Data is a decimal number.
Decimal
ALWAYS PROVIDED
The minimum rewards amount the payer must spend to redeem points for a purchase.
Data is a decimal number.
Decimal
ALWAYS PROVIDED
The rewards value available to redeem using the card.
Data is a decimal number.
Enumeration
CONDITIONAL
The rewards program the card is eligible for or enrolled in.
Value must be a member of the following list. The values are case sensitive.
AMERICAN_EXPRESS_MEMBERSHIP_REWARDS
The rewards program the card is eligible for or enrolled in.
Alphanumeric + additional characters
CONDITIONAL
An identifier generated by the gateway when you have requested the balance available for a credit or debit card.
It is only returned when a rewards balance is available for the card (response.gatewayCode=BALANCE_AVAILABLE). When redeeming rewards, include this value in the order.reward.balanceId field in the AUTHORIZE request.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'
String
CONDITIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
Alphanumeric + additional characters
ALWAYS PROVIDED
Your identifier issued to you by your provider.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Upper case alphabetic text
ALWAYS PROVIDED
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
These merchants are referred to as your sub-merchants. The sub-merchant's details you provide may be displayed on the payer's cardholder statement. Note that your acquirer may require you to register with the card scheme(s) before allowing you to submit sub-merchant details with a transaction. This data must be on the initial transaction of an order, subsequent transactions with sub-merchant will be rejected.
The sub-merchant's address.
String
CONDITIONAL
The city portion of the address.
Data can consist of any characters
String
CONDITIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
CONDITIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
CONDITIONAL
The state or province of the address.
Data can consist of any characters
String
CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
CONDITIONAL
The second line of the address (if provided).
Data can consist of any characters
Digits
CONDITIONAL
Code used by acquirer to describe the business or industry the sub-merchant operates in.
Data is a string that consists of the characters 0-9.
Email
CONDITIONAL
The sub-merchant's email address.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
CONDITIONAL
Your identifier for the sub-merchant.
You can use this identifier in searches and reports in the gateway.
Data can consist of any characters
String
CONDITIONAL
The sub-merchant's phone number
Data can consist of any characters
String
CONDITIONAL
The legal name of the sub-merchant.
Data can consist of any characters
String
CONDITIONAL
The trading name of the sub merchant, also known as doing business as (DBA), operating as or trading as.
For MasterCard transactions the name must not exceed 21 characters. For American Express transactions the name must not exceed 27 characters (or 36 characters including the aggregator name). The trading name may be displayed on the payer's cardholder statement. Therefore if you need to shorten it, use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Value as generated by the acquirer that summarizes the success or otherwise of the proposed operation.
ASCII Text
CONDITIONAL
Value as generated by the acquirer that summarizes the success or otherwise of the proposed operation.
Data consists of ASCII characters
ASCII Text
CONDITIONAL
The response from the acquirer in the text form.
This field is used in addition to response.acquirerCode for some acquirers where additional information needs to be communicated. For example, contact details to allow the merchant to contact the issuer directly to seek authorisation for the transaction.
Data consists of ASCII characters
Enumeration
ALWAYS PROVIDED
A summary of the balance inquiry response.
Value must be a member of the following list. The values are case sensitive.
BALANCE_AVAILABLE
A balance amount is available for the card.
NO_BALANCE
A balance amount is not available for the card.
TIMED_OUT
The gateway has timed out the request to the acquirer because it did not receive a response.
Enumeration
ALWAYS PROVIDED
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown
Information about the source of funds when it is directly provided (as opposed to via a token or session).
For browser payments, the source of funds details are usually collected from the payer on the payment provider's website and provided to you when you retrieve the transaction details (for a successful transaction). However, for some payment types (such as giropay), you must collect the information from the payer and supply it here.
Contains gift card details
Enumeration
ALWAYS PROVIDED
The brand name used to describe the card that is recognized and accepted globally.
For many major card types this will match the scheme name.
Value must be a member of the following list. The values are case sensitive.
LOCAL_BRAND_ONLY
The card does not have a global brand.
String
ALWAYS PROVIDED
The brand name used to describe a card as determined by the gateway, based on the BIN range of the card.
Data can consist of any characters
Masked digits
ALWAYS PROVIDED
Card number as printed or embossed on the gift card.
Data is a string that consists of the characters 0-9, plus 'x' for masking
Masked digits
CONDITIONAL
PIN number for the gift card.
Data is a string that consists of the characters 0-9, plus 'x' for masking
Enumeration
ALWAYS PROVIDED
The organization that owns a card brand and defines operating regulations for its use.
Value must be a member of the following list. The values are case sensitive.
OTHER
The scheme of the card used in the transaction could not be identified.
Alphanumeric
CONDITIONAL
Uniquely identifies a card and associated details.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
CONDITIONAL
The payment method your payer has chosen for this payment.
Value must be a member of the following list. The values are case sensitive.
CARD
The payer provided a credit or debit card as the payment method.
GIFT_CARD
The payer provided a gift card as the payment method.
Errors Copied to clipboard
Information on possible error conditions that may occur while processing an operation using the API.
Enumeration
Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.
String
Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Data can consist of any characters
String
Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Data can consist of any characters
String
Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Data can consist of any characters
Enumeration
Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.
Enumeration
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.