mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
spec release
This commit is contained in:
Adyen Automation
@@ -10,7 +10,7 @@
|
||||
"x-publicVersion" : true,
|
||||
"title" : "Adyen Recurring API",
|
||||
"description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring 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://pal-test.adyen.com/pal/servlet/Recurring/v30/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v30/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
|
||||
"x-timestamp" : "2023-02-16T11:25:28Z",
|
||||
"x-timestamp" : "2023-02-20T18:23:08Z",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Developer Experience team",
|
||||
@@ -471,7 +471,8 @@
|
||||
"city",
|
||||
"postalCode",
|
||||
"country"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"Amount" : {
|
||||
"properties" : {
|
||||
@@ -490,7 +491,8 @@
|
||||
"required" : [
|
||||
"value",
|
||||
"currency"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"BankAccount" : {
|
||||
"properties" : {
|
||||
@@ -532,7 +534,8 @@
|
||||
"description" : "The bank account holder's tax ID.",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"Card" : {
|
||||
"properties" : {
|
||||
@@ -588,7 +591,8 @@
|
||||
"required" : [
|
||||
"expiryYear",
|
||||
"holderName"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"DisableRequest" : {
|
||||
"properties" : {
|
||||
@@ -613,7 +617,8 @@
|
||||
"required" : [
|
||||
"merchantAccount",
|
||||
"shopperReference"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"DisableResult" : {
|
||||
"properties" : {
|
||||
@@ -621,7 +626,8 @@
|
||||
"description" : "Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled].",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"Name" : {
|
||||
"properties" : {
|
||||
@@ -637,7 +643,8 @@
|
||||
"required" : [
|
||||
"firstName",
|
||||
"lastName"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"NotifyShopperRequest" : {
|
||||
"properties" : {
|
||||
@@ -683,7 +690,8 @@
|
||||
"shopperReference",
|
||||
"amount",
|
||||
"reference"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"NotifyShopperResult" : {
|
||||
"properties" : {
|
||||
@@ -715,7 +723,8 @@
|
||||
"description" : "This is the recurringDetailReference returned in the response when token was created",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"Recurring" : {
|
||||
"properties" : {
|
||||
@@ -741,7 +750,8 @@
|
||||
],
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"RecurringDetail" : {
|
||||
"properties" : {
|
||||
@@ -829,7 +839,8 @@
|
||||
"required" : [
|
||||
"recurringDetailReference",
|
||||
"variant"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"RecurringDetailsRequest" : {
|
||||
"properties" : {
|
||||
@@ -849,7 +860,8 @@
|
||||
"required" : [
|
||||
"merchantAccount",
|
||||
"shopperReference"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"RecurringDetailsResult" : {
|
||||
"properties" : {
|
||||
@@ -873,7 +885,8 @@
|
||||
"description" : "The reference you use to uniquely identify the shopper (e.g. user ID or account ID).",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"ScheduleAccountUpdaterRequest" : {
|
||||
"properties" : {
|
||||
@@ -908,7 +921,8 @@
|
||||
"required" : [
|
||||
"merchantAccount",
|
||||
"reference"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"ScheduleAccountUpdaterResult" : {
|
||||
"properties" : {
|
||||
@@ -924,7 +938,8 @@
|
||||
"required" : [
|
||||
"pspReference",
|
||||
"result"
|
||||
]
|
||||
],
|
||||
"type" : "object"
|
||||
},
|
||||
"ServiceError" : {
|
||||
"properties" : {
|
||||
@@ -949,7 +964,8 @@
|
||||
"format" : "int32",
|
||||
"type" : "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"TokenDetails" : {
|
||||
"properties" : {
|
||||
@@ -962,7 +978,8 @@
|
||||
"tokenDataType" : {
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
}
|
||||
},
|
||||
"securitySchemes" : {
|
||||
|
||||
Reference in New Issue
Block a user