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

The Links API from Adyen — 2 operation(s) for links.

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

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

3 operations 2 paths 17 schemas 1 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 Links 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 3

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

Links 3
POST
/paymentLinks
Adyen Create a Payment Link
post-paymentLinks 1 param body → 201400401403422500
GET
/paymentLinks/{linkId}
Adyen Get a Payment Link
get-paymentLinks-linkId 1 param → 200400401403422500
PATCH
/paymentLinks/{linkId}
Adyen Update the Status of a Payment Link
patch-paymentLinks-linkId 1 param body → 200400401403422500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are PaymentLinkResponse (42 properties), PaymentLinkRequest (38 properties), LineItem (17 properties), ApplicationInfo (6 properties). Each schema is shown below with its type and property counts.

LineItem
object
17 properties
UpdatePaymentLinkRequest
object
1 property 1 required
ApplicationInfo
object
6 properties
CommonField
object
2 properties
MerchantDevice
object
3 properties
Address
object
6 properties 5 required
SplitAmount
object
2 properties 1 required
ServiceError
object
6 properties
InstallmentOption
object
4 properties
Name
object
2 properties 2 required
ExternalPlatform
object
3 properties
ShopperInteractionDevice
object
3 properties
RiskData
object
4 properties
Amount
object
2 properties 2 required
PaymentLinkRequest
object
38 properties 3 required
Split
object
5 properties 1 required
PaymentLinkResponse
object
42 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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