Adyen Balanceinquiry API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Adyen Balanceinquiry 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 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.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 50 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

Base URL

https://cal-test.adyen.com

Authentication

API Key, HTTP Basic

Contact

Adyen Developer Experience team

View terms

Resource Areas

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.

AccountType

string

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

PaymentAcquirerData

object

Data related to the response from the payment Acquirer.

6 properties 2 required

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

ErrorCondition

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

UTMCoordinates

object

3 properties 3 required

EntryMode

array

LoyaltyUnit

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

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

PaymentAccountReq

object

3 properties

CharacterWidth

string

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

OutputContent

object

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

5 properties 1 required

GeographicCoordinates

object

2 properties 2 required

IdentificationType

string

BarcodeType

string

Color

string

Alignment

string

OutputFormat

string

CharacterStyle

string

Geolocation

object

2 properties

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

PaymentAccountStatus

object

4 properties

CharacterHeight

string

TrackFormat

string

TypeCode

string

OutputBarcode

object

2 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

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

PaymentInstrumentType

string

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

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

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

TokenRequestedType

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

StoredValueAccountType

string

SensitiveMobileData

object

3 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

LoyaltyAccountReq

object

2 properties

AllowedProduct

object

Product that is payable by the payment card. Product codes that are payable by the payment card.

4 properties 1 required

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

LoyaltyAccountStatus

object

4 properties 1 required

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Adyen publishes across the network.

Adyen acceptDispute API

AE Profile APIs.io

Adyen Account API

AE Profile APIs.io

Adyen accountHolderBalance API

AE Profile APIs.io

Adyen accountHolders API

AE Profile APIs.io

Adyen accountHolderTransactionList API

AE Profile APIs.io

Adyen Accounting Notifications API

AE Profile APIs.io

Adyen Accounts API

AE Profile APIs.io

Adyen adjustAuthorisation API

AE Profile APIs.io

Adyen Admin API

AE Profile APIs.io

Adyen Amount API

AE Profile APIs.io

Adyen Apple API

AE Profile APIs.io

Adyen applePay API

AE Profile APIs.io

#Balanceinquiry

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Adyen Balanceinquiry API

Metadata

Authentication & Security 2

Paths & Operations 1

Schemas 50

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Adyen Balanceinquiry API

Metadata

Authentication & Security 2

Paths & Operations 1

Schemas 50

Specification

Source

More from Adyen 12

API Details

Provider

Explore more