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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Adyen

Adyen Instruments API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 9 operations across 8 paths, and defines 55 schemas. It is described by OpenAPI 3.2.0, at version 2.

Requests are made against a single base URL, https://balanceplatform-api-test.adyen.com/bcl/v2.

9 operations 8 paths 55 schemas 6 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic, API Key
Contact
Adyen Developer Experience team
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

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

Paths & Operations 9

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

Instruments 9
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 55

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

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

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
AE Profile APIs.io
Adyen Account API
AE Profile APIs.io
Adyen accountHolderBalance API
AE Profile APIs.io
Adyen accountHolderTransactionList 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 assignTerminals API
AE Profile APIs.io
Adyen Authorise API
AE Profile APIs.io
Adyen Authorise3d API
AE Profile APIs.io
#Instruments
← Back to A APIs
API Details
ID
adyen:adyen-instruments-api
Base URL
https://cal-test.adyen.com
Docs
https://docs.adyen.com/marketplaces-and-platforms/classic/configure-notifications/
Provider
Adyen
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=adyen-instruments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/adyen-instruments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Adyen Instruments 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.