Balance inquiry
Requests the balance of a card, normally a stored value card (prepaid card, giftcard).
Example request
{
"SaleToPOIRequest": {
"MessageHeader": {
"ProtocolVersion": "3.1",
"ServiceID": "2",
"MessageClass": "Service",
"MessageCategory": "BalanceInquiry",
"MessageType": "Request",
"SaleID": "ECR123",
"POIID": "AT12345"
},
"BalanceInquiryRequest": {
"AeAccessibilityMode": true
}
}
}| Property | Description | Mandatory / Optional |
|---|---|---|
| BalanceInquiryRequest | Mandatory | |
| AeAccessibilityMode | Boolean. Enable accessibility mode for transaction. Default is false. | Optional |
Example BalanceInquiry response
{
"SaleToPOIResponse": {
"MessageHeader": {
"MessageCategory": "BalanceInquiry",
"MessageClass": "Service",
"MessageType": "Response",
"POIID": "AT12345",
"ProtocolVersion": "3.1",
"SaleID": "ECR123",
"ServiceID": "2"
},
"BalanceInquiryResponse": {
"Response": {
"AeStan": "123456",
"AeAcquirerResponseCode": "00",
"AeResponseCode": "000",
"AdditionalResponse": "",
"Result": "Success"
},
"PaymentAccountStatus": {
"PaymentInstrumentData": {
"PaymentInstrumentType": "Card",
"CardData": {
"SensitiveCardData": {
"ExpiryDate": "2701"
},
"CardCountryCode": "578",
"MaskedPAN": "123481******1761",
"PaymentBrand": "Giftcard1"
}
},
"CurrentBalance": 123.45,
"Currency": "EUR"
}
}
}
}| Property | Description | Mandatory / Optional |
|---|---|---|
| BalanceInquiryResponse | Mandatory | |
| Response | Mandatory | |
| PaymentAccountStatus | Mandatory | |
| PaymentInstrumentData | Similar to Payment response | Optional |
| CurrentBalance | Balance of the stored value card. | Optional |
| Currency | Currency of the stored value card. | Optional |
Updated 13 days ago
Did this page help you?