Files
adyen-postman/postman/DataProtectionService-v1.json
2024-03-28 08:16:48 +00:00

98 lines
3.4 KiB
JSON

{
"info": {
"name": "Adyen Data Protection API (v1)",
"description": {
"content": "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.\n\nUse 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\nEach 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](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: Your_API_key\" \\n...\n```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nData Protection Service API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://ca-test.adyen.com/ca/services/DataProtectionService/v1/requestSubjectErasure\n```",
"type": "text/markdown"
},
"version": "1",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "General",
"item": [
{
"name": "/requestSubjectErasure",
"description": "Sends the PSP reference containing the shopper data that should be deleted.",
"item": [
{
"name": "Submit a Subject Erasure Request.",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"forceErasure\": \"<string>\",\n \"merchantAccount\": \"<string>\",\n \"pspReference\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/requestSubjectErasure",
"host": [
"{{baseUrl}}"
],
"path": [
"requestSubjectErasure"
],
"variable": [
],
"query": [
]
},
"description": "Sends the PSP reference containing the shopper data that should be deleted."
}
,"response": [
]
}
]
}
]
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{X-API-Key}}",
"type": "string"
},
{
"key": "key",
"value": "X-API-Key",
"type": "string"
}
]
},
"variable": [
{
"key": "baseUrl",
"value": "https://ca-test.adyen.com/ca/services/DataProtectionService/v1",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
}
]
}