Adyen

Adyen Data Protection API

Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to…

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

Adyen Data Protection API provides a way for you to process Subject Erasure Requests as mandated in GDPR.

Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email).## Authentication
Each request to the Data Protection API must be signed with an API key. Get your API Key from your Customer Area, as described in How to get the API key. Then set this key to the X-API-Key header value, for example:

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

Note that when going live, you need to generate a new API Key to access the live endpoints.

Versioning

Data Protection Service 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://ca-test.adyen.com/ca/services/DataProtectionService/v1/requestSubjectErasure

Endpoints 1

General

  • POSTSubmit a Subject Erasure Request./requestSubjectErasureSends the PSP reference containing the shopper data that should be deleted.

API details

Base URL
https://ca-test.adyen.com/ca/services/DataProtectionService/v1
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
1 operation on 1 pathPOST 1
Main resources
General 1
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1

How to test the Adyen Data Protection 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 Data Protection 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 “Submit a Subject Erasure Request.” (POST /requestSubjectErasure), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Adyen Data Protection API?

Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to… It is listed under Payments and has 1 endpoint.

Who publishes the Adyen Data Protection 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 Data Protection API?

Requests go to https://ca-test.adyen.com/ca/services/DataProtectionService/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Adyen Data Protection 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 Data Protection API have?

1 operation on 1 path (1 POST). The largest groups are General.

Is forking the Adyen Data Protection 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.