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

The Psp API from Adyen — 5 operation(s) for psp.

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

This API exposes 5 operations across 5 paths, and defines 23 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.

5 operations 5 paths 23 schemas 5 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 Psp 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 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Psp 5
POST
/payments/{paymentPspReference}/amountUpdates
Adyen Update an Authorised Amount
post-payments-paymentPspReference-amountUpdates 2 params body → 201400401403422500
POST
/payments/{paymentPspReference}/cancels
Adyen Cancel an Authorised Payment
post-payments-paymentPspReference-cancels 2 params body → 201400401403422500
POST
/payments/{paymentPspReference}/captures
Adyen Capture an Authorised Payment
post-payments-paymentPspReference-captures 2 params body → 201400401403422500
POST
/payments/{paymentPspReference}/refunds
Adyen Refund a Captured Payment
post-payments-paymentPspReference-refunds 2 params body → 201400401403422500
POST
/payments/{paymentPspReference}/reversals
Adyen Refund or Cancel a Payment
post-payments-paymentPspReference-reversals 2 params body → 201400401403422500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are LineItem (17 properties), PaymentCaptureResponse (10 properties), PaymentRefundResponse (10 properties), PaymentAmountUpdateResponse (9 properties). Each schema is shown below with its type and property counts.

LineItem
object
17 properties
PaymentCancelResponse
object
5 properties 4 required
PaymentAmountUpdateResponse
object
9 properties 6 required
PaymentRefundRequest
object
8 properties 2 required
PaymentCaptureResponse
object
10 properties 5 required
ApplicationInfo
object
6 properties
CommonField
object
2 properties
SubMerchantInfo
object
5 properties
BillingAddress
object
6 properties 5 required
MerchantDevice
object
3 properties
SplitAmount
object
2 properties 1 required
PaymentAmountUpdateRequest
object
7 properties 2 required
ServiceError
object
6 properties
PaymentReversalRequest
object
3 properties 1 required
ExternalPlatform
object
3 properties
PaymentCaptureRequest
object
8 properties 2 required
ShopperInteractionDevice
object
3 properties
Amount
object
2 properties 2 required
PaymentRefundResponse
object
10 properties 5 required
PaymentCancelRequest
object
3 properties 1 required
PaymentReversalResponse
object
5 properties 4 required
PlatformChargebackLogic
object
3 properties
Split
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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