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 Instruments API

The Instruments API from Adyen — 9 operation(s) for instruments.

Adyen Instruments 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 Instruments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 10 operations across 9 paths, and defines 56 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.

10 operations 9 paths 56 schemas 7 GET1 PATCH2 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 Instruments 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 10

Across 9 paths, the API surfaces 10 operations — 7 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Instruments 10
GET
/balanceAccounts/{id}/paymentInstruments
Adyen Get Payment Instruments Linked to a Balance Account
get-balanceAccounts-id-paymentInstruments 4 params → 200400401403422500
POST
/paymentInstrumentGroups
Adyen Create a Payment Instrument Group
post-paymentInstrumentGroups body → 200400401403422500
GET
/paymentInstrumentGroups/{id}
Adyen Get a Payment Instrument Group
get-paymentInstrumentGroups-id 1 param → 200400401403422500
GET
/paymentInstrumentGroups/{id}/transactionRules
Adyen Get All Transaction Rules for a Payment Instrument Group
get-paymentInstrumentGroups-id-transactionRules 1 param → 200400401403422500
POST
/paymentInstruments
Adyen Create a Payment Instrument
post-paymentInstruments body → 200400401403422500
GET
/paymentInstruments/{id}
Adyen Get a Payment Instrument
get-paymentInstruments-id 1 param → 200400401403422500
PATCH
/paymentInstruments/{id}
Adyen Update a Payment Instrument
patch-paymentInstruments-id 1 param body → 200400401403422500
GET
/paymentInstruments/{id}/networkTokens
Adyen List Network Tokens
get-paymentInstruments-id-networkTokens 1 param → 200400401403422500
GET
/paymentInstruments/{id}/reveal
Adyen Get the PAN of a Payment Instrument
get-paymentInstruments-id-reveal 1 param → 200400401403422500
GET
/paymentInstruments/{id}/transactionRules
Adyen Get All Transaction Rules for a Payment Instrument
get-paymentInstruments-id-transactionRules 1 param → 200400401403422500

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are TransactionRuleRestrictions (17 properties), TransactionRule (14 properties), CardConfiguration (14 properties), Card (13 properties). Each schema is shown below with its type and property counts.

CountriesRestriction
object
2 properties 1 required
UpdatePaymentInstrument
object
12 properties 4 required
PaymentInstrument
object
11 properties 4 required
TimeOfDay
object
2 properties
DeliveryContact
object
6 properties 2 required
CardConfiguration
object
14 properties 1 required
PaginatedPaymentInstrumentsResponse
object
3 properties 3 required
StringMatch
object
2 properties
ProcessingTypesRestriction
object
2 properties 1 required
PaymentInstrumentRevealInfo
object
3 properties 3 required
ListNetworkTokensResponse
object
1 property
Card
object
13 properties 5 required
USLocalAccountIdentification
object
4 properties 3 required
TimeOfDayRestriction
object
2 properties 1 required
DeviceInfo
object
11 properties
TotalAmountRestriction
object
2 properties 1 required
InternationalTransactionRestriction
object
2 properties 1 required
Expiry
object
2 properties
BulkAddress
object
9 properties 1 required
Duration
object
2 properties
MerchantNamesRestriction
object
2 properties 1 required
SameCounterpartyRestriction
object
2 properties 1 required
TransactionRulesResponse
object
1 property
RestServiceError
object
9 properties 5 required
BankAccountModel
object
1 property
CounterpartyBankRestriction
object
2 properties 1 required
IbanAccountIdentification
object
2 properties 2 required
DifferentCurrenciesRestriction
object
2 properties 1 required
Authentication
object
3 properties
PhoneNumber
object
3 properties
DayOfWeekRestriction
object
2 properties 1 required
TransactionRuleRestrictions
object
17 properties
InvalidField
object
3 properties 3 required
JSONObject
object
DeliveryAddress
object
7 properties 1 required
PaymentInstrumentInfo
object
10 properties 3 required
ActiveNetworkTokensRestriction
object
2 properties 1 required
BrandVariantsRestriction
object
2 properties 1 required
Name
object
2 properties 2 required
MerchantAcquirerPair
object
2 properties
TransactionRule
object
14 properties 6 required
EntryModesRestriction
object
2 properties 1 required
Amount
object
2 properties 2 required
TransactionRuleInterval
object
6 properties 1 required
CardInfo
object
8 properties 4 required
NetworkToken
object
8 properties
Phone
object
2 properties 2 required
SameAmountRestriction
object
2 properties 1 required
MerchantsRestriction
object
2 properties 1 required
BankIdentification
object
3 properties
PaymentInstrumentGroup
object
6 properties 2 required
TransactionRuleEntityKey
object
2 properties
PaymentInstrumentUpdateRequest
object
5 properties
MatchingTransactionsRestriction
object
2 properties 1 required
MccsRestriction
object
2 properties 1 required
PaymentInstrumentGroupInfo
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-instruments-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