Adyen

Adyen Instruments API

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

GitHub OpenAPI
Business capability
Card Issuance Management BC-1340.60

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /paymentInstrumentGroups Create a group of payment instruments · Adyen Create a Payment Instrument Group #
Ask an LLM
“How do I group issued cards together so one transaction rule covers them all?”
“What balance platform and card variant does a payment instrument group need?”
Tell an agent
Create a payment instrument group on balance platform {balancePlatform} for variant {txVariant}.
Create an instrument group {reference} on {balancePlatform} with tx variant {txVariant} and description {description}.
GET /paymentInstrumentGroups/{id} Get a payment instrument group · Adyen Get a Payment Instrument Group #
Ask an LLM
“What's in a particular payment instrument group?”
“Can I look up the balance platform a card group belongs to?”
Tell an agent
Get payment instrument group {id}.
Show the details of instrument group {id}.
GET /paymentInstrumentGroups/{id}/transactionRules List transaction rules on an instrument group · Adyen Get All Transaction Rules for a Payment Instrument Group #
Ask an LLM
“Which spending rules apply to a whole group of cards?”
“What transaction rules are attached to a payment instrument group?”
Tell an agent
List transaction rules for payment instrument group {id}.
Show every rule that applies to instrument group {id}.
POST /paymentInstruments Issue a card or business account · Adyen Create a Payment Instrument #
Ask an LLM
“How do I issue a virtual or physical card to one of my users?”
“Can I create a business account instrument instead of a card?”
Tell an agent
Issue a {type} payment instrument on balance account {balanceAccountId} in country {issuingCountryCode}.
Create a card instrument for balance account {balanceAccountId}, country {issuingCountryCode}, type {type}, with card details {card}.
GET /paymentInstruments/{id} Get a payment instrument · Adyen Get a Payment Instrument #
Ask an LLM
“What status is a particular issued card in?”
“Which balance account is a payment instrument linked to?”
Tell an agent
Get payment instrument {id}.
Show status and balance account of instrument {id}.
PATCH /paymentInstruments/{id} Block, suspend or reactivate a card · Adyen Update a Payment Instrument #
Ask an LLM
“How do I suspend or block a card I've issued?”
“Which fields can I still change once a payment instrument is active?”
Tell an agent
Set payment instrument {id} status to {status} with reason {statusReason}.
Move instrument {id} to balance account {balanceAccountId}.
GET /paymentInstruments/{id}/networkTokens List network tokens for a card · Adyen List Network Tokens #
Ask an LLM
“Which wallet or network tokens exist for one of my issued cards?”
“Can I see all tokens provisioned from a payment instrument?”
Tell an agent
List network tokens for payment instrument {id}.
Show tokens provisioned from card {id}.
GET /paymentInstruments/{id}/reveal Reveal a card's full card number · Adyen Get the PAN of a Payment Instrument #
Ask an LLM
“How can I retrieve the full PAN of a card I issued?”
“What role does my credential need to reveal a card number?”
Tell an agent
Reveal the PAN of payment instrument {id}.
Get the full card number for instrument {id}.
GET /paymentInstruments/{id}/transactionRules List transaction rules on one card · Adyen Get All Transaction Rules for a Payment Instrument #
Ask an LLM
“What spending rules are applied to one specific card?”
“Can I check which rules might decline transactions on a payment instrument?”
Tell an agent
Get the rules applied to the single card instrument {id}.
Show the rules attached to card {id}.

Documentation

📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/configure-notifications/
📖
Documentation
https://docs.adyen.com/api-explorer/Account/6/overview
📖
Documentation
https://docs.adyen.com/development-resources/webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/BalanceControl/1/overview
📖
Documentation
https://docs.adyen.com/api-explorer/BinLookup/52/overview
📖
Documentation
https://docs.adyen.com/api-explorer/Checkout/71/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform/2/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/development-resources/data-protection-api/
📖
Documentation
https://docs.adyen.com/risk-management/disputes-api
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/fund-transfer/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/hosted/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/legal-entity-management-api/
📖
Documentation
https://docs.adyen.com/api-explorer/Management/3/overview
📖
Documentation
https://docs.adyen.com/api-explorer/management-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/notifications
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/notifications/
📖
Documentation
https://docs.adyen.com/online-payments/
📖
Documentation
https://docs.adyen.com/online-payments/online-payouts
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/
📖
Documentation
https://docs.adyen.com/online-payments/tokenization
📖
Documentation
https://docs.adyen.com/api-explorer/report-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/payment-methods/gift-cards/stored-value-api/
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/terminal-api-reference/
📖
Documentation
https://docs.adyen.com/development-resources/testing/create-test-cards
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/business-accounts/transactions/transaction-webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/transfer-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/on-demand-payouts
📖
Documentation
https://docs.adyen.com/development-resources/webhooks

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-instruments-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/asyncapi/adyen-webhooks-asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/adyen-instruments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

adyen-instruments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '2'
  x-publicVersion: true
  title: Adyen Configuration Instruments API
  description: The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts.
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://balanceplatform-api-test.adyen.com/bcl/v2
tags:


# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-instruments-api-openapi.yml