StoredValue

Message category	Class	Direction
`StoredValue`	Service	ECR → terminal

📘
Used in these guides
Gift cards

For merchants supporting it, a stored value card can be activated and loaded with a selected amount. If already activated, the balance of the card is increased with the loaded amount.

Funding of the loaded amount is handled separately.

Example request and response

storedvalue

All fields

Example StoredValue request to load a giftcard

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Service",
      "MessageCategory": "StoredValue",
      "MessageType": "Request",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "StoredValueRequest": {
      "SaleData": {
        "SaleTransactionID": {
          "TransactionID": "12345678",
          "TimeStamp": "2024-04-18T22:16:13.178+02:00"
        }
      },
      "StoredValueData": [
        {
          "StoredValueTransactionType": "Load",
          "ItemAmount": 100.00
        }
      ]
    }
  }
}

Field	Required	Description
`StoredValueRequest`	Required	Contains the fields below
↳ `SaleData`	Required	Same as for Payment request
↳ `StoredValueData`	Optional	List, normally one
↳ `StoredValueTransactionType`	Required	"Load" for load/activation
↳ `ItemAmount`	Optional	Amount to be loaded

Example StoredValue response to load/activate a giftcard

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Service",
      "MessageCategory": "StoredValue",
      "MessageType": "Response",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "StoredValueResponse": {
      "Response": {
        "AeStan": "123456",
        "AeAcquirerResponseCode": "00",
        "AeResponseCode": "000",
        "AdditionalResponse": "",
        "Result": "Success"
      },
      "POIData": {
        "POITransactionID": {
          "TransactionID": "87654321",
          "TimeStamp": "2024-04-18T22:16:13.478+02:00"
        },
        "POIReconciliationID": "20240418_001"
      },
      "StoredValueResult": [
        {
          "StoredValueTransactionType": "Load",
          "ItemAmount": 100.00,
          "Currency": "EUR",
          "StoredValueAccountStatus": {
            "CurrentBalance": 100.00
          }
        }
      ]
    }
  }
}

Field	Required	Description
`StoredValueResponse`	Required	Contains the fields below
↳ `Response`	Required	Same layout as in every response. See the example responses on Payment and the example error response on Login
↳ `SaleData`	Required
↳ `POIData`	Required
↳ `StoredValueResult`	Required	List of results, normally one
↳ `StoredValueTransactionType`	Required	Copy of request
↳ `ItemAmount`	Required	Amount loaded
↳ `Currency`	Required	Copy of request
↳ `StoredValueAccountStatus`	Required	Contains the fields below
↳ `CurrentBalance`	Optional	Balance of the account, if present or known