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

The transactionRules API from Adyen — 2 operation(s) for transactionrules.

Adyen transactionRules 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 transactionRules. 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.1.0, at version 6.

Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.

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.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 transactionRules 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 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.

transactionRules 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.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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