Adyen

Account-to-Account (A2A) payments API

The A2A payments API provides endpoints for A2A payment flows, enabling issuers to facilitate direct payments through Adyen for users with an Adyen business…

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

The A2A payments API provides endpoints for A2A payment flows, enabling issuers to facilitate direct payments through Adyen for users with an Adyen business account.

With these endpoints, you can:

  • Retrieve payment details: Retrieve transaction information for specific payments.
  • Confirm payments: Confirm payments with Strong Customer Authentication (SCA).
  • Cancel payments: Cancel pending transactions.

Authentication

Each request made to the A2A Payments API must be signed with an API key. Generate an API key in your Customer Area.

To connect to the API, 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" \
...

Roles and permissions

To use the A2A Payments API, your API credential must have the following roles:

  • Role for A2A Issuer payments - API

Reach out to your Adyen contact to set up these roles.

Going live

When going live, generate an API key in your live Customer Area. You can then use the API key to send requests to https://balanceplatform-api-live.adyen.com/a2aissuer-api/v{version}/payments.

Endpoints 6

Payments

  • POSTCancel payment/payments/cancelCancels the payment. Returns a URL for user redirection.
  • POSTConfirm payment/payments/confirmConfirms the payment using Strong Customer Authentication (SCA). To confirm a payment you must make this request two times: 1. Make this request to initiate…
  • POSTRetrieve payment details/payments/detailsReturns the details of an open payment, which you must show to the user. Also provides a token required to confirm or cancel the payment.

iDEAL profiles

  • POSTManage an iDEAL profile/ideal/profile/auth-linkManage an already registered iDEAL profile. Generates a redirection URL to manage the iDEAL profile linked to the account holder from the request.
  • POSTAuthenticate iDEAL profile/ideal/profile/authenticateGenerates an redirection URL to finish the authentication flow when requested by iDEAL. Before calling this endpoint, make sure that your user has completed…
  • POSTRegister an iDEAL profile/ideal/profile/registerRegister a new iDEAL profile. The profile is linked to the account holder and payment instruments included in the request. The user must be redirected to the…

API details

Base URL
https://balanceplatform-api-test.adyen.com/a2aissuer-api/v1
https://balanceplatform-api-live.adyen.com/a2aissuer-api/v1
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
6 operations on 6 pathsPOST 6
Main resources
Payments 3iDEAL profiles 3
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1

How to test the Account-to-Account (A2A) payments 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 Account-to-Account (A2A) payments 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 “Cancel payment” (POST /payments/cancel), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Account-to-Account (A2A) payments API?

The A2A payments API provides endpoints for A2A payment flows, enabling issuers to facilitate direct payments through Adyen for users with an Adyen business… It is listed under Payments and has 6 endpoints.

Who publishes the Account-to-Account (A2A) payments 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 Account-to-Account (A2A) payments API?

Its description lists 2 base URLs: https://balanceplatform-api-test.adyen.com/a2aissuer-api/v1, https://balanceplatform-api-live.adyen.com/a2aissuer-api/v1. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Account-to-Account (A2A) payments 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 Account-to-Account (A2A) payments API have?

6 operations on 6 paths (6 POST). The largest groups are Payments, iDEAL profiles.

Is forking the Account-to-Account (A2A) payments 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.