diff --git a/json/RecurringService-v25.json b/json/RecurringService-v25.json index f356497..a9a77ec 100644 --- a/json/RecurringService-v25.json +++ b/json/RecurringService-v25.json @@ -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/v25/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" : { diff --git a/json/RecurringService-v30.json b/json/RecurringService-v30.json index 0c7555d..d1880ef 100644 --- a/json/RecurringService-v30.json +++ b/json/RecurringService-v30.json @@ -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" : { diff --git a/json/RecurringService-v40.json b/json/RecurringService-v40.json index 0558fe0..093ddb5 100644 --- a/json/RecurringService-v40.json +++ b/json/RecurringService-v40.json @@ -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/v40/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", @@ -994,6 +1004,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" : { diff --git a/json/RecurringService-v49.json b/json/RecurringService-v49.json index 457e00a..9eec9e1 100644 --- a/json/RecurringService-v49.json +++ b/json/RecurringService-v49.json @@ -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/v49/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", @@ -1002,6 +1012,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" : { diff --git a/json/RecurringService-v67.json b/json/RecurringService-v67.json index a6d5072..6b66c19 100644 --- a/json/RecurringService-v67.json +++ b/json/RecurringService-v67.json @@ -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/v67/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", @@ -1002,6 +1012,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" : { diff --git a/json/RecurringService-v68.json b/json/RecurringService-v68.json index acb3113..25f5514 100644 --- a/json/RecurringService-v68.json +++ b/json/RecurringService-v68.json @@ -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/v68/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", @@ -1007,6 +1017,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" : { diff --git a/yaml/RecurringService-v25.yaml b/yaml/RecurringService-v25.yaml index 5371622..8888178 100644 --- a/yaml/RecurringService-v25.yaml +++ b/yaml/RecurringService-v25.yaml @@ -49,7 +49,7 @@ info: https://pal-test.adyen.com/pal/servlet/Recurring/v25/disable ```' - 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 @@ -64,7 +64,7 @@ paths: post: 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. @@ -125,7 +125,7 @@ paths: post: 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 @@ -188,7 +188,7 @@ paths: post: 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). @@ -201,12 +201,18 @@ paths: requestBody: content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment' schema: $ref: '#/components/schemas/NotifyShopperRequest' responses: '200': content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment-200' schema: $ref: '#/components/schemas/NotifyShopperResult' description: OK - the request has succeeded. @@ -244,7 +250,7 @@ paths: post: 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: @@ -853,6 +859,28 @@ components: contract: RECURRING shopperReference: YOUR_UNIQUE_SHOPPER_ID 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: diff --git a/yaml/RecurringService-v30.yaml b/yaml/RecurringService-v30.yaml index e499b5e..92e4570 100644 --- a/yaml/RecurringService-v30.yaml +++ b/yaml/RecurringService-v30.yaml @@ -49,7 +49,7 @@ info: https://pal-test.adyen.com/pal/servlet/Recurring/v30/disable ```' - 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 @@ -64,7 +64,7 @@ paths: post: 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. @@ -125,7 +125,7 @@ paths: post: 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 @@ -188,7 +188,7 @@ paths: post: 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). @@ -201,12 +201,18 @@ paths: requestBody: content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment' schema: $ref: '#/components/schemas/NotifyShopperRequest' responses: '200': content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment-200' schema: $ref: '#/components/schemas/NotifyShopperResult' description: OK - the request has succeeded. @@ -244,7 +250,7 @@ paths: post: 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: @@ -853,6 +859,28 @@ components: contract: RECURRING shopperReference: YOUR_UNIQUE_SHOPPER_ID 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: diff --git a/yaml/RecurringService-v40.yaml b/yaml/RecurringService-v40.yaml index 5629818..0adcd41 100644 --- a/yaml/RecurringService-v40.yaml +++ b/yaml/RecurringService-v40.yaml @@ -49,7 +49,7 @@ info: https://pal-test.adyen.com/pal/servlet/Recurring/v40/disable ```' - 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 @@ -64,7 +64,7 @@ paths: post: 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. @@ -125,7 +125,7 @@ paths: post: 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 @@ -188,7 +188,7 @@ paths: post: 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). @@ -201,12 +201,18 @@ paths: requestBody: content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment' schema: $ref: '#/components/schemas/NotifyShopperRequest' responses: '200': content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment-200' schema: $ref: '#/components/schemas/NotifyShopperResult' description: OK - the request has succeeded. @@ -244,7 +250,7 @@ paths: post: 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: @@ -864,6 +870,28 @@ components: contract: RECURRING shopperReference: YOUR_UNIQUE_SHOPPER_ID 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: diff --git a/yaml/RecurringService-v49.yaml b/yaml/RecurringService-v49.yaml index 8d0a030..275d47a 100644 --- a/yaml/RecurringService-v49.yaml +++ b/yaml/RecurringService-v49.yaml @@ -49,7 +49,7 @@ info: https://pal-test.adyen.com/pal/servlet/Recurring/v49/disable ```' - 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 @@ -64,7 +64,7 @@ paths: post: 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. @@ -125,7 +125,7 @@ paths: post: 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 @@ -188,7 +188,7 @@ paths: post: 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). @@ -201,12 +201,18 @@ paths: requestBody: content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment' schema: $ref: '#/components/schemas/NotifyShopperRequest' responses: '200': content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment-200' schema: $ref: '#/components/schemas/NotifyShopperResult' description: OK - the request has succeeded. @@ -244,7 +250,7 @@ paths: post: 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: @@ -872,6 +878,28 @@ components: contract: RECURRING shopperReference: YOUR_UNIQUE_SHOPPER_ID 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: diff --git a/yaml/RecurringService-v67.yaml b/yaml/RecurringService-v67.yaml index 149c2e0..074341b 100644 --- a/yaml/RecurringService-v67.yaml +++ b/yaml/RecurringService-v67.yaml @@ -49,7 +49,7 @@ info: https://pal-test.adyen.com/pal/servlet/Recurring/v67/disable ```' - 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 @@ -64,7 +64,7 @@ paths: post: 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. @@ -125,7 +125,7 @@ paths: post: 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 @@ -188,7 +188,7 @@ paths: post: 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). @@ -201,12 +201,18 @@ paths: requestBody: content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment' schema: $ref: '#/components/schemas/NotifyShopperRequest' responses: '200': content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment-200' schema: $ref: '#/components/schemas/NotifyShopperResult' description: OK - the request has succeeded. @@ -244,7 +250,7 @@ paths: post: 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: @@ -872,6 +878,28 @@ components: contract: RECURRING shopperReference: YOUR_UNIQUE_SHOPPER_ID 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: diff --git a/yaml/RecurringService-v68.yaml b/yaml/RecurringService-v68.yaml index 90f13f7..9d669eb 100644 --- a/yaml/RecurringService-v68.yaml +++ b/yaml/RecurringService-v68.yaml @@ -49,7 +49,7 @@ info: https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ```' - 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 @@ -64,7 +64,7 @@ paths: post: 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. @@ -125,7 +125,7 @@ paths: post: 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 @@ -188,7 +188,7 @@ paths: post: 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). @@ -201,12 +201,18 @@ paths: requestBody: content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment' schema: $ref: '#/components/schemas/NotifyShopperRequest' responses: '200': content: application/json: + examples: + notifyShopperOfUpcomingRecurringPayment: + $ref: '#/components/examples/post-notifyShopper-notifyShopperOfUpcomingRecurringPayment-200' schema: $ref: '#/components/schemas/NotifyShopperResult' description: OK - the request has succeeded. @@ -244,7 +250,7 @@ paths: post: 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: @@ -881,6 +887,28 @@ components: contract: RECURRING shopperReference: YOUR_UNIQUE_SHOPPER_ID 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: