Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adyen Storedvalue API

The Storedvalue API from Adyen — 1 operation(s) for storedvalue.

Adyen Storedvalue API is one of 202 APIs that Adyen publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Storedvalue. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 34 schemas. It is described by OpenAPI 3.1.0, at version 6.

Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.

1 operations 1 paths 34 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
6
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

Adyen Storedvalue API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Storedvalue 1
POST
/storedvalue
Adyen StoredValue Request
body → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are SaleData (12 properties), OutputText (11 properties), OriginalPOITransaction (9 properties), StoredValueData (8 properties). Each schema is shown below with its type and property counts.

POIData
object
In the Message Response, identification of the POI transaction. Data related to the POI System.
2 properties 1 required
ErrorCondition
string
EntryMode
array
Response
object
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 r…
3 properties 1 required
StoredValueAccountID
object
It contains the identifications of the stored value account or the stored value card, and the associated product sold by the Sale System for stored value reque…
7 properties 4 required
TransactionIDType
object
Identification of a transaction for the Sale System or the POI System.
2 properties 2 required
Result
string
StoredValueRequest
object
It conveys Information related to the Stored Value transaction to process. Content of the Stored Value Request message.
3 properties 2 required
CharacterWidth
string
StoredValueTransactionType
string
OutputContent
object
This is a sequence of elements if they have different formats. Content to display or print.
5 properties 1 required
IdentificationType
string
BarcodeType
string
Color
string
OutputFormat
string
Alignment
string
SaleData
object
Data associated to the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition. Data related to t…
12 properties 1 required
StoredValueResult
object
For each stored value card loaded or reloaded, in the StoredValue response message. Result of loading/reloading a stored value card..
7 properties 1 required
CharacterStyle
string
CharacterHeight
string
OutputBarcode
object
2 properties 1 required
StoredValueData
object
It contains: - the identification of the stored value accounts or the stored value cards, if provided by the Sale System, and - the associated products sold by…
8 properties 1 required
OutputText
object
It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print a…
11 properties 1 required
PaymentReceipt
object
If the payment receipts are printed by the Sale system and the POI or the Sale does not implement the Print exchange (Basic profile). Customer or Merchant paym…
4 properties 2 required
DocumentQualifier
string
TokenRequestedType
string
StoredValueResponse
object
It conveys Information related to the Stored Value transaction processed by the POI System. Content of the Stored Value Response message.
5 properties 3 required
OriginalPOITransaction
object
In the Payment or the Loyalty Request message, it allows using the card of a previous CardAcquisition or Payment/Loyalty request. Identification of a previous…
9 properties
StoredValueAccountType
string
StoredValueAccountStatus
object
2 properties 1 required
PredefinedContent
object
It conveys Information related to the predefined message. Reference of a predefined message to display or print.
2 properties 1 required
SaleTerminalData
object
In the Login Request, if a Sale Terminal is involved in the login. In other messages, when a logical device is out of order (SaleCapabilites), or when the othe…
1 property
CustomerOrderReq
array
SaleToIssuerData
object
The POI System receives this information and sends it to the Acquirer for the Issuer without any change. Sale information intended for the Issuer.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-storedvalue-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolders API
Adyen accountHolderTransactionList API
Adyen Accounting Notifications API
Adyen Accounts API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen applePay API