Adyen

Adyen Payment API

A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.

> This API is inactive.
> * If you are building a new integration, use the Checkout API instead.
> * If you have an existing integration using this API, reach out to your Adyen contact and migrate to the Checkout API.
>The Checkout API enables your online payments integration to accept all supported payment methods, use the latest features, and access more benefits.

To learn more about the API, visit Classic integration.

Authentication

You need an API credential to authenticate to the API.

If using an API key, add an X-API-Key header with the API key as the value, for example:

curl
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
...

Alternatively, you can use the username and password to connect to the API using basic authentication, for example:

curl
-u "ws@Company.YOUR_COMPANY_ACCOUNT":"YOUR_BASIC_AUTHENTICATION_PASSWORD" \
-H "Content-Type: application/json" \
...

Versioning

Payments API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise

Going live

To authenticate to the live endpoints, you need an API credential from your live Customer Area.

The live endpoint URLs contain a prefix which is unique to your company account:


https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise

Get your {PREFIX} from your live Customer Area under Developers > API URLs > Prefix.

Endpoints 13

Payments

  • POSTCreate an authorisation/authoriseCreates a payment with a unique reference (pspReference) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled…
  • POSTComplete a 3DS authorisation/authorise3dFor an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the md and paResponse parameters that you get from the…
  • POSTComplete a 3DS2 authorisation/authorise3ds2For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the threeDS2Token and threeDS2Result parameters. >…
  • POSTGet the 3DS authentication result/getAuthenticationResultReturn the authentication result after doing a 3D Secure authentication only.
  • POSTGet the 3DS2 authentication result/retrieve3ds2ResultRetrieves the threeDS2Result after doing a 3D Secure 2 authentication only.

Modifications

  • POSTChange the authorised amount/adjustAuthorisationAllows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping,…
  • POSTCancel an authorisation/cancelCancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment…
  • POSTCancel or refund a payment/cancelOrRefundCancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has…
  • POSTCapture an authorisation/captureCaptures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's…
  • POSTCreate a donation/donateDeprecated. Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original…
  • POSTRefund a captured payment/refundRefunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a…
  • POSTCancel an authorisation using your reference/technicalCancelThis endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available. In your call, refer to the…
  • POSTCancel an in-person refund/voidPendingRefundThis endpoint allows you to cancel an unreferenced refund request before it has been completed. In your call, you can refer to the original refund request…

API details

Base URL
https://pal-test.adyen.com/pal/servlet/Payment/v68
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
13 operations on 13 pathsPOST 13
1 marked deprecated
Main resources
Modifications 8Payments 5
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 68

How to test the Adyen Payment API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Adyen Payment API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create an authorisation” (POST /authorise), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Adyen Payment API?

A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments… It is listed under Payments and has 13 endpoints.

Who publishes the Adyen Payment API?

It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Adyen Payment API?

Requests go to https://pal-test.adyen.com/pal/servlet/Payment/v68. Endpoint paths are added to this base URL.

How do I authenticate with the Adyen Payment API?

It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).

How many endpoints does the Adyen Payment API have?

13 operations on 13 paths (13 POST). The largest groups are Modifications, Payments.

Is forking the Adyen Payment API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.