How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adyen Balanceinquiry API

The Balanceinquiry API from Adyen — 1 operation(s) for balanceinquiry.

Adyen Balanceinquiry API is one of 138 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 Balanceinquiry. 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 50 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against 3 base URLs: https://terminal-api-test.adyen.com/sync, https://terminal-api-test.adyen.com/async, .

1 operations 1 paths 50 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Adyen Balanceinquiry 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.

Balanceinquiry 1
POST
/balanceinquiry
Adyen BalanceInquiry Request
body → 200

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are OutputText (11 properties), CardData (11 properties), CustomerOrder (10 properties), CheckData (7 properties). Each schema is shown below with its type and property counts.

Color
string
LoyaltyAccountID
object
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 acc…
4 properties 3 required
TrackData
object
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…
3 properties 1 required
CustomerOrder
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 cl…
10 properties 4 required
UTMCoordinates
object
3 properties 3 required
PaymentAccountReq
object
3 properties
GeographicCoordinates
object
2 properties 2 required
TrackFormat
string
BalanceInquiryRequest
object
It conveys Information related to the account for which a Balance Inquiry is requested. Content of the Balance Inquiry Request message.
2 properties
IdentificationType
string
SensitiveMobileData
object
3 properties 1 required
LoyaltyAccountStatus
object
4 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
AccountType
string
PaymentToken
object
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 cust…
3 properties 2 required
PaymentInstrumentType
string
PredefinedContent
object
It conveys Information related to the predefined message. Reference of a predefined message to display or print.
2 properties 1 required
ErrorCondition
string
CharacterHeight
string
Geolocation
object
2 properties
CheckData
object
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. Inf…
7 properties
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
OutputBarcode
object
2 properties 1 required
Result
string
BarcodeType
string
EntryMode
array
CharacterStyle
string
TypeCode
string
LoyaltyAccountReq
object
2 properties
PaymentAcquirerData
object
Data related to the response from the payment Acquirer.
6 properties 2 required
SensitiveCardData
object
This data structure could be CMS protected (EnvelopedData). In this case the data structure SensitiveCardData is replaced by the data structure ProtectedCardDa…
4 properties
PaymentInstrumentData
object
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. Data rela…
6 properties 1 required
LoyaltyUnit
string
MobileData
object
Mobile phone is used as a payment instrument for the transaction. Information related to the mobile for the payment transaction.
6 properties
OutputContent
object
This is a sequence of elements if they have different formats. Content to display or print.
5 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
TokenRequestedType
string
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
OutputFormat
string
CardData
object
Allows acquisition of the card data by the Sale System before the Payment, CardAcquisition or BalanceInquiry request to the POI. It could also be sent in the C…
11 properties
PaymentAccountStatus
object
4 properties
BalanceInquiryResponse
object
It conveys the balance and the identification of the associated payment, loyalty or stored value account. Content of the Balance Inquiry Response message.
4 properties 1 required
TransactionIDType
object
Identification of a transaction for the Sale System or the POI System.
2 properties 2 required
StoredValueAccountType
string
DocumentQualifier
string
IdentificationSupport
string
LoyaltyAccount
object
This data structure conveys the identification of the account and the associated loyalty brand. Data related to a loyalty account processed in the transaction.
2 properties 1 required
Alignment
string
CharacterWidth
string
AllowedProduct
object
Product that is payable by the payment card. Product codes that are payable by the payment card.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-balanceinquiry-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolderTransactionList API
Adyen Accounts API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen assignTerminals API
Adyen Authorise API
Adyen Authorise3d API
Where this information came from

This is an independent, third-party profile of Adyen Balanceinquiry API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.