jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2022-08-18 13:45:18 +00:00
parent ffa9fed4ec
commit 8e0a783d4b
12 changed files with 450 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
json/RecurringService-v30.json
View File

@@ -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\nTo connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\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```",
"x-timestamp" : "2022-05-03T09:24:07Z",
"x-timestamp" : "2022-07-19T19:18:39Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -32,7 +32,7 @@
"tags" : [
"General"
],
"summary" : "Disables stored payment details.",
"summary" : "Disable stored payment details",
"description" : "Disables stored payment details to stop charging a shopper with this particular recurring detail ID.\n\nFor more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).",
"operationId" : "post-disable",
"x-groupName" : "General",
@@ -130,7 +130,7 @@
"tags" : [
"General"
],
"summary" : "Retrieves stored payment details for a shopper.",
"summary" : "Get stored payment details",
"description" : "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper.\n\nFor more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).",
"operationId" : "post-listRecurringDetails",
"x-groupName" : "General",
@@ -228,7 +228,7 @@
"tags" : [
"General"
],
"summary" : "Ask the issuer to inform shopper of upcoming payment",
"summary" : "Ask issuer to notify the shopper",
"description" : "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).",
"operationId" : "post-notifyShopper",
"x-groupName" : "General",
@@ -246,6 +246,11 @@
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"notifyShopperOfUpcomingRecurringPayment" : {
"$ref" : "#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotifyShopperRequest"
}
@@ -256,6 +261,11 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"notifyShopperOfUpcomingRecurringPayment" : {
"$ref" : "#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/NotifyShopperResult"
}
@@ -321,7 +331,7 @@
"tags" : [
"General"
],
"summary" : "Schedules running of the Account Updater.",
"summary" : "Schedule running the Account Updater",
"description" : "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference:\n* If the card information is provided, all the sub-fields for `card` are mandatory.\n* If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.",
"x-addedInVersion" : "4",
"operationId" : "post-scheduleAccountUpdater",
@@ -983,6 +993,33 @@
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
}
},
"post-notifyShopper-notifyShopperOfUpcomingRecurringPayment" : {
"summary" : "Request issuer to notify shopper of upcoming recurring payment",
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"storedPaymentMethodId" : "8415995487234100",
"shopperReference" : "YOUR_SHOPPER_REFERENCE",
"amount" : {
"currency" : "INR",
"value" : 1000
},
"billingDate" : "2021-03-16",
"reference" : "Example reference",
"displayedReference" : "exampleDisplayedReference"
}
},
"post-notifyShopper-notifyShopperOfUpcomingRecurringPayment-200" : {
"summary" : "Example response for request 'notifyShopper'",
"value" : {
"message" : "Request Processed Successfully",
"resultCode" : "Success",
"shopperNotificationReference" : "9915003646742627",
"storedPaymentMethodId" : "8415995487234100",
"pspReference" : "M5N7TQ4TG5PFWR50",
"reference" : "Example reference",
"displayedReference" : "exampleDisplayedReference"
}
},
"post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData" : {
"summary" : "Schedule AccountUpdater with card data",
"value" : {