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

The Rules API from Adyen — 4 operation(s) for rules.

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

This API exposes 4 operations across 2 paths, and defines 32 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.

4 operations 2 paths 32 schemas 1 DELETE1 GET1 PATCH1 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
Terms of Service
Resource Areas
1

Authentication & Security 3

Adyen Rules 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 4

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

Rules 4
POST
/transactionRules
Adyen Create a Transaction Rule
post-transactionRules body → 200400401403422500
DELETE
/transactionRules/{transactionRuleId}
Adyen Delete a Transaction Rule
delete-transactionRules-transactionRuleId 1 param → 200400401403422500
GET
/transactionRules/{transactionRuleId}
Adyen Get a Transaction Rule
get-transactionRules-transactionRuleId 1 param → 200400401403422500
PATCH
/transactionRules/{transactionRuleId}
Adyen Update a Transaction Rule
patch-transactionRules-transactionRuleId 1 param body → 200400401403422500

Schemas 32

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

TimeOfDayRestriction
object
2 properties 1 required
InvalidField
object
3 properties 3 required
RestServiceError
object
9 properties 5 required
Duration
object
2 properties
Amount
object
2 properties 2 required
TransactionRuleEntityKey
object
2 properties
BrandVariantsRestriction
object
2 properties 1 required
CountriesRestriction
object
2 properties 1 required
TotalAmountRestriction
object
2 properties 1 required
MccsRestriction
object
2 properties 1 required
DayOfWeekRestriction
object
2 properties 1 required
TransactionRuleInterval
object
6 properties 1 required
TransactionRuleInfo
object
13 properties 6 required
ProcessingTypesRestriction
object
2 properties 1 required
DifferentCurrenciesRestriction
object
2 properties 1 required
TransactionRuleResponse
object
1 property
JSONObject
object
ActiveNetworkTokensRestriction
object
2 properties 1 required
TransactionRule
object
14 properties 6 required
SameAmountRestriction
object
2 properties 1 required
StringMatch
object
2 properties
TransactionRuleRestrictions
object
17 properties
MatchingTransactionsRestriction
object
2 properties 1 required
SameCounterpartyRestriction
object
2 properties 1 required
MerchantsRestriction
object
2 properties 1 required
EntryModesRestriction
object
2 properties 1 required
MerchantAcquirerPair
object
2 properties
MerchantNamesRestriction
object
2 properties 1 required
BankIdentification
object
3 properties
CounterpartyBankRestriction
object
2 properties 1 required
TimeOfDay
object
2 properties
InternationalTransactionRestriction
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-rules-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 Rules 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.