BalanceInquiry Request

HTTP Responses

• 200

  Content of the Balance Inquiry Response message. It conveys the balance and the identification of the associated payment, loyalty or stored value account.

  Show moreShow less

  Responseobject

  Result of a message request processing. If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can refine the processing of the message response. AdditionalResponse gives more information about the success or the failure of the message request processing, for logging without real time involvements.

  Show childrenHide children

  Resultstring

  Result of the processing of the message. Possible values:

  • Failure
  • Partial
  • Success

  ErrorConditionstring

  Condition that has produced an error on the processing of a message request. Returned if Result is not Success. Possible values:

  • Aborted
  • Busy
  • Cancel
  • DeviceOut
  • InProgress
  • InsertedCard
  • InvalidCard
  • LoggedOut
  • MessageFormat
  • NotAllowed
  • NotFound
  • PaymentRestriction
  • Refusal
  • UnavailableDevice
  • UnavailableService
  • UnreachableHost
  • WrongPIN

  AdditionalResponsestring

  Additional information related to processing status of a message request. If present, the POI logs it for further examination.

  PaymentAccountStatusobject

  Data related to the result of a Balance Inquiry request. If BalanceInquiryRequest. PaymentAccount present.

  Show childrenHide children

  PaymentInstrumentDataobject

  Data related to the instrument of payment for the transaction. Sent in the result of the payment transaction. For a card, it could also be sent in the CardAcquisition response, to be processed by the Sale System.

  Show childrenHide children

  PaymentInstrumentTypestring

  Type of payment instrument. Possible values:

  • Card
  • Cash
  • Check
  • Mobile
  • StoredValue

  ProtectedCardDatastring

  Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.

  CardDataobject

  Information related to the payment card used for the transaction. Allows acquisition of the card data by the Sale System before the Payment, CardAcquisition, or BalanceInquiry request to the POI. It can also be sent in the CardAcquisition response, to be processed by the Sale System.

  Show childrenHide children

  PaymentBrandstring

  Type of payment card. If card PAN is readable. Indicates the card used to pay in the PaymentResponse. Sent in the CardAcquisitionResponse, to leave the Cashier to choose between several applications in a smartcard, or several brand in a co-branded card. In this case, the CardAcquisitionRequest.ForceCustomerSelectionFlag must contain the value False. Brands are part of the POI and Sale Systems configurations.

  MaskedPanstring

  Masked Primary Account Number Part of the PAN is replaced by a string of * characters, to identify a customer account or relationship. Presence of this data element, which replace the PAN when SensitiveCardData is protected and replaced by ProtectedCardData. Alternatively the MaskedPAN can be used as a token to identify a customer.

  PaymentAccountRefstring

  Reference of the PAN, which identifies the PAN or the card uniquely, named also PAR (Payment Account Reference). This reference may be defined by the card issuer or by a token service provider under the control of the card issuer, and cannot be used for a payment transaction.

  EntryModearray[string]

  Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. Possible values:

  • Contactless
  • File
  • ICC
  • Keyed
  • MagStripe
  • Manual
  • Mobile
  • RFID
  • Scanned
  • SynchronousICC
  • Tapped

  CardCountryCodeinteger

  Minimum: 3Maximum: 3

  Country Code attached to the card (3 numerics). If available in the card.

  ProtectedCardDatastring

  Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.

  SensitiveCardDataobject

  This data structure could be CMS protected (EnvelopedData). In this case the data structure SensitiveCardData is replaced by the data structure ProtectedCardData of type ContentInformationType. When this data is protected, the exact content is unknown by the Sale System, and might include all the information which are required by an external backup POI Server to make a batch payment transaction in case of problem with the POI System. Sensitive information related to the payment card, entered or read by the Sale System.

  Show childrenHide children

  PANinteger

  Minimum: 8Maximum: 28

  Primary Account Number.

  CardSeqNumbinteger

  Minimum: 2Maximum: 3

  Card Sequence Number. If EntryMode is File, Keyed, or Manual.

  ExpiryDateinteger

  Minimum: 4Maximum: 4

  Date after which the card cannot be used. If EntryMode is File.

  TrackDataarray[object]

  Magnetic track or magnetic ink characters line. If EntryMode is MagStripe or RFID .

  Show childrenHide children

  TrackNumbinteger

  Minimum: 1Maximum: 3

  Card track number.

  TrackFormatstring

  Magnetic track or magnetic ink characters line. Possible values:

  • AAMVA
  • ISO

  TrackValuestring

  Card track content.

  AllowedProductCodearray[integer]

  Product codes that are payable by the payment card. If not all the products are accepted for the payment card proposed by the Customer. In this case, Result is failure, ErrorCondition is Payment Restriction. For One Time Reservation, the POI can send product codes payable by the payment, even if the POI did not send SaleItem in the request. If at least one product sent in the request is accepted, the Result is Success. Product codes that are payable by the payment card. If all the products are not accepted for the payment card proposed by the Customer. In this case, Result is failure and ErrorCondition is Payment Restriction. For One Time Reservation, the POI can send product codes payable by the payment, even if the POI did not send SaleItem in the request. If at least one product sent in the request is accepted, the Result is Success.

  AllowedProductarray[object]

  Product that is payable by the payment card.

  Show childrenHide children

  ProductCodeinteger

  Minimum: 1Maximum: 20

  Product code of item purchased with the transaction.

  EanUpcinteger

  Standard product code of item purchased with the transaction.

  ProductLabelstring

  Product name of an item purchased with the transaction.

  AdditionalProductInfostring

  Additionl information related to the line item.

  PaymentTokenobject

  Surrogate of the PAN (Primary Account Number) of the payment card to identify the payment mean of the customer. It allows, for a merchant, to identify the customer.

  Show childrenHide children

  TokenRequestedTypestring

  Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period. Possible values:

  • Customer
  • Transaction

  TokenValuestring

  Payment token replacing the PAN of the payment card to identify the payment mean of the customer.

  ExpiryDateTimestring

  Expiry date and time. Limits the validity of a payment token.

  CustomerOrderarray[object]

  Customer order attached to a customer, recorded in the POI system. Allows the management of customer orders by the POI, for instance in a multi-channel or a click and collect sale transaction.

  Show childrenHide children

  CustomerOrderIDstring

  Additional and optional identification of a customer order.

  SaleReferenceIDstring

  Identification of a Sale global transaction for a sequence of related POI transactions. Identification of a reservation transaction for the sequence of reservation and the completion.

  OpenOrderStateboolean

  Specifies if a customer order is currently Open. An open customer order is an order waiting for further operations.

  StartDatestring

  Date time of the beginning of an operation.

  EndDatestring

  Date time of the end of an operation.

  ForecastedAmountnumber

  Maximum: 99999999.999999

  Depending on the choice of the sale system it could equal the initial amount of the order or the global amount of the order. If ForecastedAmount equals the initial amount of the order it will allow the system to follow any additional payment. In case of equality with the global amount of the order, the system will then be able to follow remaining amounts.

  CurrentAmountnumber

  Maximum: 99999999.999999

  Total amount of all completed transactions of a customer order.

  Currencystring

  Currency of a monetary amount.

  AccessedBystring

  Identification of an entity accessing data to perform an operation. Allow the synchronisation of customer order processing, when several parts of the Sale System access a customer order at the same time. The Sale entity active on the customer order is identified by this data.

  AdditionalInformationstring

  Unqualified information.

  CheckDataobject

  Information related to the paper check used for the transaction. Allows the check information to be provided by the Sale System before requesting the payment, or stored by the Sale System after processing of the payment.

  Show childrenHide children

  BankIDstring

  Identification of the bank. Mandatory if TrackData absent.

  AccountNumberstring

  Identification of the customer account. Mandatory if TrackData absent.

  CheckNumberstring

  Identification of the bank check. Mandatory if TrackData absent.

  TrackDataobject

  Magnetic track or magnetic ink characters line. ISO 7813 - ISO 4909. Generic data structure for a card track, used when the magstripe card reader is located on the Sale Terminal, or for magstripe Card Reader device request. The data structure is also used to store the line at the bottom of a bank check.

  Show childrenHide children

  TrackNumbinteger

  Minimum: 1Maximum: 3

  Card track number.

  TrackFormatstring

  Magnetic track or magnetic ink characters line. Possible values:

  • AAMVA
  • ISO

  TrackValuestring

  Card track content.

  CheckCardNumberstring

  Check guarantee card number. If provided by the customer.

  TypeCodestring

  Type of bank check. Possible values:

  • Company
  • Personal

  Countrystring

  Country of the bank check. Absent if country of the Sale system.

  MobileDataobject

  Mobile phone is used as a payment instrument for the transaction. Information related to the mobile for the payment transaction.

  Show childrenHide children

  MobileCountryCodeinteger

  Minimum: 3Maximum: 3

  Identifies the country of a mobile phone operator. If data available.

  MobileNetworkCodeinteger

  Minimum: 2Maximum: 3

  Identifies the mobile phone operator inside a country. If data available.

  MaskedMSISDNinteger

  Masked Mobile Subscriber Integrated Service Digital Network. If data available.

  Geolocationobject

  Geographic location specified by geographic or UTM coordinates. If data available.

  Show childrenHide children

  GeographicCoordinatesobject

  Show childrenHide children

  Latitudestring

  Angular distance of a location on the earth south or north of the equator.

  Longitudestring

  Angular measurement of the distance of a location on the earth east or west of the Greenwich observatory.

  UTMCoordinatesobject

  Show childrenHide children

  UTMZonestring

  UTM grid zone combination of the longitude zone (1 to 60) and the latitude band (C to X, excluding I and O).

  UTMEastwardstring

  X-coordinate of the Universal Transverse Mercator coordinate system.

  UTMNorthwardstring

  Y-coordinate of the Universal Transverse Mercator coordinate system.

  ProtectedMobileDatastring

  Sensitive information related to the mobile phone, protected by CMS. SensitiveMobileData.

  SensitiveMobileDataobject

  Sensitive information related to the mobile phone. If unprotected mobile data.

  Show childrenHide children

  MSISDNinteger

  Mobile Subscriber Integrated Service Digital Network (i.e. mobile phone number of the SIM card). Country, National Destination Code, and Subscriber Number.

  IMSIinteger

  International Mobile Subscriber Identity. Unique number associated with the mobile phone user, containing the Mobile Country Code (MCC), the Mobile Network Code (MNC), and the Mobile Identification Number (MSIN)

  IMEIinteger

  International Mobile Equipment Identity. Unique number associated with the mobile phone device.

  StoredValueAccountIDobject

  Identification of the stored value account or the stored value card and the associated product sold by the Sale System for stored value requests.

  Show childrenHide children

  StoredValueAccountTypestring

  Type of stored value account. Allows the distinction of the stored value instrument to access the stored value account. Possible values:

  • GiftCard
  • Other
  • PhoneCard

  StoredValueProviderstring

  Identification of the provider of the stored value account load/reload. When the ProductCode is not sufficient to identify the provider host which delivers the load or reload of the stored value account (for example if it contains the identification of the application.)

  OwnerNamestring

  Name of the owner of a stored value account.

  ExpiryDateinteger

  Minimum: 4Maximum: 4

  Date after which the card cannot be used. If EMV expiry date is present, it overrides Track2 information. Format is MMYY.

  EntryModearray[string]

  Entry mode of the payment instrument information. In the Payment, Loyalty, or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. (e.g. because the payment instrument information are a barcode read by the Cashier on a scanner device). Possible values:

  • Contactless
  • File
  • ICC
  • Keyed
  • MagStripe
  • Manual
  • Mobile
  • RFID
  • Scanned
  • SynchronousICC
  • Tapped

  IdentificationTypestring

  Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification. Possible values:

  • AccountNumber
  • BarCode
  • ISOTrack2
  • PAN
  • PhoneNumber

  StoredValueIDstring

  Stored value account identification. The identification of the stored value account conforming to the IdentificationType.

  CurrentBalancenumber

  Maximum: 99999999.999999

  Balance of an account after processing of the transaction.

  Currencystring

  Currency of a monetary amount.

  PaymentAcquirerDataobject

  Data related to the response from the payment Acquirer.

  Show childrenHide children

  AcquirerIDinteger

  Identification of the Acquirer. Identification of the Acquirer when the POI System is multi-acquirer.

  MerchantIDstring

  Identification of the Merchant for the Acquirer.

  AcquirerPOIIDstring

  Identification of the POI for the payment Acquirer.

  AcquirerTransactionIDobject

  Identification of a transaction for the Sale System or the POI System.

  Show childrenHide children

  TransactionIDstring

  Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.

  TimeStampstring

  Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

  ApprovalCodestring

  Code assigned to a transaction approval by the Acquirer. If available.

  HostReconciliationIDstring

  Identifier of a reconciliation period with a payment or loyalty host. Allows the assignment of a transaction to the Acquirer reconciliation (or batch).

  LoyaltyAccountStatusobject

  Data related to the result of a loyalty Balance Inquiry. If BalanceInquiryRequest. LoyaltyData present.

  Show childrenHide children

  LoyaltyAccountobject

  This data structure conveys the identification of the account and the associated loyalty brand. Data related to a loyalty account processed in the transaction.

  Show childrenHide children

  LoyaltyAccountIDobject

  Identification of a Loyalty account. In the Payment or the Loyalty Request message, it allows to identify the loyalty account by the Sale Terminal instead of the POI Terminal (e.g. because the account identification is a bar-code read by the Cashier on a scanner device).

  Show childrenHide children

  EntryModearray[string]

  Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. Possible values:

  • Contactless
  • File
  • ICC
  • Keyed
  • MagStripe
  • Manual
  • Mobile
  • RFID
  • Scanned
  • SynchronousICC
  • Tapped

  IdentificationTypestring

  Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification. Possible values:

  • AccountNumber
  • BarCode
  • ISOTrack2
  • PAN
  • PhoneNumber

  IdentificationSupportstring

  Support of the loyalty account identification. Allows knowing where and how you have found the loyalty account identification. Possible values:

  • HybridCard
  • LinkedCard
  • LoyaltyCard
  • NoCard

  LoyaltyIDstring

  Loyalty account identification conforming to the IdentificationType.

  LoyaltyBrandstring

  Identification of a Loyalty brand. If a card is analysed.

  CurrentBalancenumber

  Maximum: 99999999.999999

  Balance of an account after processing of the transaction.

  LoyaltyUnitstring

  Unit of a loyalty amount. The amount could be expressed in point or in a monetary value and a currency. Possible values:

  • Monetary
  • Point

  Currencystring

  Currency of a monetary amount.

  PaymentReceiptarray[object]

  Show childrenHide children

  DocumentQualifierstring

  Qualification of the document to print to the Cashier or the Customer. SaleReceipt or CashierReceipt. Possible values:

  • CashierReceipt
  • CustomerReceipt
  • Document
  • Journal
  • SaleReceipt
  • Voucher

  IntegratedPrintFlagboolean

  Type of the print integrated to other prints.

  RequiredSignatureFlagboolean

  Indicate that the cardholder payment receipt requires a physical signature by the Customer.

  OutputContentobject

  Content to display or print. This is a sequence of elements if they have different formats.

  Show childrenHide children

  OutputFormatstring

  Format of the content to display or print. Display or print device function. Possible values:

  • BarCode
  • MessageRef
  • Text
  • XHTML

  PredefinedContentobject

  Reference of a predefined message to display or print. It conveys information related to the predefined message.

  Show childrenHide children

  ReferenceIDstring

  Identification of a predefined message to display or print.

  Languagestring

  Identification of a language.

  OutputTextarray[object]

  Content of text message to display or print. Mandatory, if OutputFormat is Text, not allowed otherwise. One instance of OutputText per shared format.

  Show childrenHide children

  Textstring

  Content of text message to display, print or play.

  CharacterSetinteger

  Character height of the text string to display or print. Absence of this data element means the characters have normal height.

  Fontstring

  Name of the font. Used to change character font of the output, as agreed between the POI and Sale Systems.

  StartRowinteger

  Minimum: 1Maximum: 500

  Row where the text string has to be displayed or printed.

  StartColumninteger

  Minimum: 1Maximum: 500

  Column where the text string has to be displayed or printed.

  Colorstring

  Color of the text string to display or print. Possible values:

  • Black
  • Blue
  • Cyan
  • Green
  • Magenta
  • Red
  • White
  • Yellow

  CharacterWidthstring

  Character width of the text string to display or print. Absence of this data element means the characters have normal width. Possible values:

  • DoubleWidth
  • SingleWidth

  CharacterHeightstring

  Character height of the text string to display or print. Absence of this data element means the characters have normal height. Possible values:

  • DoubleHeight
  • HalfHeight
  • SingleHeight

  CharacterStylestring

  Typographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style. Possible values:

  • Bold
  • Italic
  • Normal
  • Underline

  Alignmentstring

  Alignment of the text string on the display line or print line. Absence of this data element means the characters have normal alignment. Possible values:

  • Centred
  • Justified
  • Left
  • Right

  EndOfLineFlagboolean

  Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.

  OutputXHTMLstring

  XHTML document body containing the message to display or print. Mandatory if OutputFormat is XHTML, not allowed otherwise.

  OutputBarcodeobject

  Barcode content to display or print. Mandatory if OutputFormat is Barcode, not allowed otherwise.

  Show childrenHide children

  BarcodeTypestring

  Type of Barcode coding. Qualification of the barcode value to display or print. Possible values:

  • Code128
  • Code25
  • EAN13
  • EAN8
  • PDF417
  • QRCode
  • UPCA

  BarcodeValuestring

  Value with a Barcode coding. The barcode value to display or print.