From 1f284643a07029f827ef4893eeee759931850cfc Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Mon, 17 Jun 2024 11:00:43 +0200 Subject: [PATCH] spec release --- json/RecurringService-v25.json | 36 +++++ json/RecurringService-v30.json | 36 +++++ json/RecurringService-v40.json | 36 +++++ json/RecurringService-v49.json | 36 +++++ json/RecurringService-v67.json | 36 +++++ json/RecurringService-v68.json | 240 +++++++++++++++++++++++++++++++++ yaml/RecurringService-v25.yaml | 25 ++++ yaml/RecurringService-v30.yaml | 25 ++++ yaml/RecurringService-v40.yaml | 25 ++++ yaml/RecurringService-v49.yaml | 25 ++++ yaml/RecurringService-v67.yaml | 25 ++++ yaml/RecurringService-v68.yaml | 165 +++++++++++++++++++++++ 12 files changed, 710 insertions(+) diff --git a/json/RecurringService-v25.json b/json/RecurringService-v25.json index 37f9cfd..703ba73 100644 --- a/json/RecurringService-v25.json +++ b/json/RecurringService-v25.json @@ -363,6 +363,14 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterResult" } @@ -403,6 +411,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1067,6 +1080,13 @@ } } }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" : { + "summary" : "Scheduled Account Updater with card data", + "value" : { + "pspReference" : "QFQTPCQ8HXSKGK82", + "result" : "Success" + } + }, "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { "summary" : "Schedule AccountUpdater with token data", "value" : { @@ -1075,6 +1095,22 @@ "shopperReference" : "YOUR_SHOPPER_REFERENCE", "selectedRecurringDetailReference" : "8814232895168272" } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" : { + "summary" : "Scheduled Account Updater with token data", + "value" : { + "pspReference" : "JLCMPCQ8HXSKGK82", + "result" : "Success" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" : { + "summary" : "Error response for RecurringShopper not found", + "value" : { + "status" : 422, + "errorCode" : "000", + "message" : "RecurringShopper not found", + "errorType" : "validation" + } } } } diff --git a/json/RecurringService-v30.json b/json/RecurringService-v30.json index a291d62..6e4ed1e 100644 --- a/json/RecurringService-v30.json +++ b/json/RecurringService-v30.json @@ -363,6 +363,14 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterResult" } @@ -403,6 +411,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1067,6 +1080,13 @@ } } }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" : { + "summary" : "Scheduled Account Updater with card data", + "value" : { + "pspReference" : "QFQTPCQ8HXSKGK82", + "result" : "Success" + } + }, "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { "summary" : "Schedule AccountUpdater with token data", "value" : { @@ -1075,6 +1095,22 @@ "shopperReference" : "YOUR_SHOPPER_REFERENCE", "selectedRecurringDetailReference" : "8814232895168272" } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" : { + "summary" : "Scheduled Account Updater with token data", + "value" : { + "pspReference" : "JLCMPCQ8HXSKGK82", + "result" : "Success" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" : { + "summary" : "Error response for RecurringShopper not found", + "value" : { + "status" : 422, + "errorCode" : "000", + "message" : "RecurringShopper not found", + "errorType" : "validation" + } } } } diff --git a/json/RecurringService-v40.json b/json/RecurringService-v40.json index 8655af0..71a468f 100644 --- a/json/RecurringService-v40.json +++ b/json/RecurringService-v40.json @@ -457,6 +457,14 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterResult" } @@ -497,6 +505,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1281,6 +1294,13 @@ } } }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" : { + "summary" : "Scheduled Account Updater with card data", + "value" : { + "pspReference" : "QFQTPCQ8HXSKGK82", + "result" : "Success" + } + }, "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { "summary" : "Schedule AccountUpdater with token data", "value" : { @@ -1289,6 +1309,22 @@ "shopperReference" : "YOUR_SHOPPER_REFERENCE", "selectedRecurringDetailReference" : "8814232895168272" } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" : { + "summary" : "Scheduled Account Updater with token data", + "value" : { + "pspReference" : "JLCMPCQ8HXSKGK82", + "result" : "Success" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" : { + "summary" : "Error response for RecurringShopper not found", + "value" : { + "status" : 422, + "errorCode" : "000", + "message" : "RecurringShopper not found", + "errorType" : "validation" + } } } } diff --git a/json/RecurringService-v49.json b/json/RecurringService-v49.json index f5f1bb5..e4f8f81 100644 --- a/json/RecurringService-v49.json +++ b/json/RecurringService-v49.json @@ -457,6 +457,14 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterResult" } @@ -497,6 +505,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1289,6 +1302,13 @@ } } }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" : { + "summary" : "Scheduled Account Updater with card data", + "value" : { + "pspReference" : "QFQTPCQ8HXSKGK82", + "result" : "Success" + } + }, "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { "summary" : "Schedule AccountUpdater with token data", "value" : { @@ -1297,6 +1317,22 @@ "shopperReference" : "YOUR_SHOPPER_REFERENCE", "selectedRecurringDetailReference" : "8814232895168272" } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" : { + "summary" : "Scheduled Account Updater with token data", + "value" : { + "pspReference" : "JLCMPCQ8HXSKGK82", + "result" : "Success" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" : { + "summary" : "Error response for RecurringShopper not found", + "value" : { + "status" : 422, + "errorCode" : "000", + "message" : "RecurringShopper not found", + "errorType" : "validation" + } } } } diff --git a/json/RecurringService-v67.json b/json/RecurringService-v67.json index 7ff4ec1..338b3b3 100644 --- a/json/RecurringService-v67.json +++ b/json/RecurringService-v67.json @@ -551,6 +551,14 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterResult" } @@ -591,6 +599,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1415,6 +1428,13 @@ } } }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" : { + "summary" : "Scheduled Account Updater with card data", + "value" : { + "pspReference" : "QFQTPCQ8HXSKGK82", + "result" : "Success" + } + }, "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { "summary" : "Schedule AccountUpdater with token data", "value" : { @@ -1423,6 +1443,22 @@ "shopperReference" : "YOUR_SHOPPER_REFERENCE", "selectedRecurringDetailReference" : "8814232895168272" } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" : { + "summary" : "Scheduled Account Updater with token data", + "value" : { + "pspReference" : "JLCMPCQ8HXSKGK82", + "result" : "Success" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" : { + "summary" : "Error response for RecurringShopper not found", + "value" : { + "status" : 422, + "errorCode" : "000", + "message" : "RecurringShopper not found", + "errorType" : "validation" + } } } } diff --git a/json/RecurringService-v68.json b/json/RecurringService-v68.json index 1cf4005..304aaa1 100644 --- a/json/RecurringService-v68.json +++ b/json/RecurringService-v68.json @@ -308,6 +308,100 @@ } } }, + "/forward" : { + "post" : { + "tags" : [ + "General" + ], + "summary" : "Ask 3rd party processor to process the request and send back the response", + "description" : "Validates a forward request with RDR and sends the specified request to the 3rd party processor so they can send the response back.", + "x-addedInVersion" : "68", + "operationId" : "post-forward", + "x-sortIndex" : 0, + "x-methodName" : "forward", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ForwardRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ForwardResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/listRecurringDetails" : { "post" : { "tags" : [ @@ -551,6 +645,14 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithCardData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" + }, + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" + } + }, "schema" : { "$ref" : "#/components/schemas/ScheduleAccountUpdaterResult" } @@ -591,6 +693,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "scheduleAccountUpdaterWithTokenData" : { + "$ref" : "#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -890,6 +997,56 @@ }, "type" : "object" }, + "ForwardRequest" : { + "additionalProperties" : false, + "properties" : { + "baseUrl" : { + "description" : "The base url to forward the request", + "type" : "string" + }, + "merchantAccount" : { + "description" : "The merchant account code", + "type" : "string" + }, + "request" : { + "description" : "The details of the request to be sent", + "$ref" : "#/components/schemas/OutgoingForwardRequest" + }, + "shopperReference" : { + "description" : "The shopper reference", + "type" : "string" + }, + "storedPaymentMethodId" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token or it is passed by the account to find the existing recurring details", + "type" : "string" + } + }, + "required" : [ + "merchantAccount", + "shopperReference", + "storedPaymentMethodId", + "baseUrl", + "request" + ], + "type" : "object" + }, + "ForwardResponse" : { + "additionalProperties" : false, + "properties" : { + "response" : { + "description" : "The details of the from the forwarded party ", + "$ref" : "#/components/schemas/ThirdPartyForwardResponse" + }, + "storedPaymentMethodId" : { + "description" : "Recurring Detail Reference", + "type" : "string" + } + }, + "required" : [ + "response" + ], + "type" : "object" + }, "Name" : { "additionalProperties" : false, "properties" : { @@ -992,6 +1149,44 @@ }, "type" : "object" }, + "OutgoingForwardRequest" : { + "additionalProperties" : false, + "properties" : { + "body" : { + "description" : "The body of the http request to be sent", + "type" : "string" + }, + "credentials" : { + "description" : "The credentials needed to authenticate on the third party ", + "type" : "string" + }, + "headers" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "The headers that the request will be sent with. Supports the placeholder `{{credentials}}`", + "type" : "object" + }, + "httpMethod" : { + "description" : "The http method that the request will be sent via", + "enum" : [ + "POST", + "PUT", + "PATCH" + ], + "type" : "string" + }, + "urlSuffix" : { + "description" : "The path that the request will be sent to", + "type" : "string" + } + }, + "required" : [ + "httpMethod", + "body" + ], + "type" : "object" + }, "Permit" : { "additionalProperties" : false, "properties" : { @@ -1334,6 +1529,28 @@ }, "type" : "object" }, + "ThirdPartyForwardResponse" : { + "additionalProperties" : false, + "properties" : { + "body" : { + "description" : "Body of the response from the forwarded party", + "type" : "string" + }, + "headers" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "Http headers of the response from the forwarded party", + "type" : "object" + }, + "status" : { + "description" : "Http status of the response from the forwarded party", + "format" : "int32", + "type" : "integer" + } + }, + "type" : "object" + }, "TokenDetails" : { "additionalProperties" : false, "properties" : { @@ -1420,6 +1637,13 @@ } } }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200" : { + "summary" : "Scheduled Account Updater with card data", + "value" : { + "pspReference" : "QFQTPCQ8HXSKGK82", + "result" : "Success" + } + }, "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData" : { "summary" : "Schedule AccountUpdater with token data", "value" : { @@ -1428,6 +1652,22 @@ "shopperReference" : "YOUR_SHOPPER_REFERENCE", "selectedRecurringDetailReference" : "8814232895168272" } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200" : { + "summary" : "Scheduled Account Updater with token data", + "value" : { + "pspReference" : "JLCMPCQ8HXSKGK82", + "result" : "Success" + } + }, + "post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422" : { + "summary" : "Error response for RecurringShopper not found", + "value" : { + "status" : 422, + "errorCode" : "000", + "message" : "RecurringShopper not found", + "errorType" : "validation" + } } } } diff --git a/yaml/RecurringService-v25.yaml b/yaml/RecurringService-v25.yaml index 5da9419..3183459 100644 --- a/yaml/RecurringService-v25.yaml +++ b/yaml/RecurringService-v25.yaml @@ -250,6 +250,11 @@ paths: '200': content: application/json: + examples: + scheduleAccountUpdaterWithCardData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200' + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200' schema: $ref: '#/components/schemas/ScheduleAccountUpdaterResult' description: OK - the request has succeeded. @@ -274,6 +279,9 @@ paths: '422': content: application/json: + examples: + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -899,6 +907,11 @@ components: expiryYear: '2030' holderName: Adyen Test number: '4111111111111111' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200: + summary: Scheduled Account Updater with card data + value: + pspReference: QFQTPCQ8HXSKGK82 + result: Success post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData: summary: Schedule AccountUpdater with token data value: @@ -906,3 +919,15 @@ components: reference: YOUR_REFERENCE shopperReference: YOUR_SHOPPER_REFERENCE selectedRecurringDetailReference: '8814232895168272' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200: + summary: Scheduled Account Updater with token data + value: + pspReference: JLCMPCQ8HXSKGK82 + result: Success + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422: + summary: Error response for RecurringShopper not found + value: + status: 422 + errorCode: '000' + message: RecurringShopper not found + errorType: validation diff --git a/yaml/RecurringService-v30.yaml b/yaml/RecurringService-v30.yaml index 4d6c1ad..635ac9d 100644 --- a/yaml/RecurringService-v30.yaml +++ b/yaml/RecurringService-v30.yaml @@ -250,6 +250,11 @@ paths: '200': content: application/json: + examples: + scheduleAccountUpdaterWithCardData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200' + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200' schema: $ref: '#/components/schemas/ScheduleAccountUpdaterResult' description: OK - the request has succeeded. @@ -274,6 +279,9 @@ paths: '422': content: application/json: + examples: + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -899,6 +907,11 @@ components: expiryYear: '2030' holderName: Adyen Test number: '4111111111111111' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200: + summary: Scheduled Account Updater with card data + value: + pspReference: QFQTPCQ8HXSKGK82 + result: Success post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData: summary: Schedule AccountUpdater with token data value: @@ -906,3 +919,15 @@ components: reference: YOUR_REFERENCE shopperReference: YOUR_SHOPPER_REFERENCE selectedRecurringDetailReference: '8814232895168272' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200: + summary: Scheduled Account Updater with token data + value: + pspReference: JLCMPCQ8HXSKGK82 + result: Success + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422: + summary: Error response for RecurringShopper not found + value: + status: 422 + errorCode: '000' + message: RecurringShopper not found + errorType: validation diff --git a/yaml/RecurringService-v40.yaml b/yaml/RecurringService-v40.yaml index f52d8af..6490bbb 100644 --- a/yaml/RecurringService-v40.yaml +++ b/yaml/RecurringService-v40.yaml @@ -306,6 +306,11 @@ paths: '200': content: application/json: + examples: + scheduleAccountUpdaterWithCardData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200' + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200' schema: $ref: '#/components/schemas/ScheduleAccountUpdaterResult' description: OK - the request has succeeded. @@ -330,6 +335,9 @@ paths: '422': content: application/json: + examples: + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1055,6 +1063,11 @@ components: expiryYear: '2030' holderName: Adyen Test number: '4111111111111111' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200: + summary: Scheduled Account Updater with card data + value: + pspReference: QFQTPCQ8HXSKGK82 + result: Success post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData: summary: Schedule AccountUpdater with token data value: @@ -1062,3 +1075,15 @@ components: reference: YOUR_REFERENCE shopperReference: YOUR_SHOPPER_REFERENCE selectedRecurringDetailReference: '8814232895168272' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200: + summary: Scheduled Account Updater with token data + value: + pspReference: JLCMPCQ8HXSKGK82 + result: Success + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422: + summary: Error response for RecurringShopper not found + value: + status: 422 + errorCode: '000' + message: RecurringShopper not found + errorType: validation diff --git a/yaml/RecurringService-v49.yaml b/yaml/RecurringService-v49.yaml index 0957631..a8552db 100644 --- a/yaml/RecurringService-v49.yaml +++ b/yaml/RecurringService-v49.yaml @@ -306,6 +306,11 @@ paths: '200': content: application/json: + examples: + scheduleAccountUpdaterWithCardData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200' + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200' schema: $ref: '#/components/schemas/ScheduleAccountUpdaterResult' description: OK - the request has succeeded. @@ -330,6 +335,9 @@ paths: '422': content: application/json: + examples: + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1063,6 +1071,11 @@ components: expiryYear: '2030' holderName: Adyen Test number: '4111111111111111' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200: + summary: Scheduled Account Updater with card data + value: + pspReference: QFQTPCQ8HXSKGK82 + result: Success post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData: summary: Schedule AccountUpdater with token data value: @@ -1070,3 +1083,15 @@ components: reference: YOUR_REFERENCE shopperReference: YOUR_SHOPPER_REFERENCE selectedRecurringDetailReference: '8814232895168272' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200: + summary: Scheduled Account Updater with token data + value: + pspReference: JLCMPCQ8HXSKGK82 + result: Success + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422: + summary: Error response for RecurringShopper not found + value: + status: 422 + errorCode: '000' + message: RecurringShopper not found + errorType: validation diff --git a/yaml/RecurringService-v67.yaml b/yaml/RecurringService-v67.yaml index 95dc411..2a28269 100644 --- a/yaml/RecurringService-v67.yaml +++ b/yaml/RecurringService-v67.yaml @@ -361,6 +361,11 @@ paths: '200': content: application/json: + examples: + scheduleAccountUpdaterWithCardData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200' + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200' schema: $ref: '#/components/schemas/ScheduleAccountUpdaterResult' description: OK - the request has succeeded. @@ -385,6 +390,9 @@ paths: '422': content: application/json: + examples: + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -1143,6 +1151,11 @@ components: expiryYear: '2030' holderName: Adyen Test number: '4111111111111111' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200: + summary: Scheduled Account Updater with card data + value: + pspReference: QFQTPCQ8HXSKGK82 + result: Success post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData: summary: Schedule AccountUpdater with token data value: @@ -1150,3 +1163,15 @@ components: reference: YOUR_REFERENCE shopperReference: YOUR_SHOPPER_REFERENCE selectedRecurringDetailReference: '8814232895168272' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200: + summary: Scheduled Account Updater with token data + value: + pspReference: JLCMPCQ8HXSKGK82 + result: Success + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422: + summary: Error response for RecurringShopper not found + value: + status: 422 + errorCode: '000' + message: RecurringShopper not found + errorType: validation diff --git a/yaml/RecurringService-v68.yaml b/yaml/RecurringService-v68.yaml index f09f551..4d94c31 100644 --- a/yaml/RecurringService-v68.yaml +++ b/yaml/RecurringService-v68.yaml @@ -203,6 +203,62 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /forward: + post: + tags: + - General + summary: Ask 3rd party processor to process the request and send back the response + description: Validates a forward request with RDR and sends the specified request + to the 3rd party processor so they can send the response back. + x-addedInVersion: '68' + operationId: post-forward + x-sortIndex: 0 + x-methodName: forward + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /listRecurringDetails: post: tags: @@ -361,6 +417,11 @@ paths: '200': content: application/json: + examples: + scheduleAccountUpdaterWithCardData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200' + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200' schema: $ref: '#/components/schemas/ScheduleAccountUpdaterResult' description: OK - the request has succeeded. @@ -385,6 +446,9 @@ paths: '422': content: application/json: + examples: + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. @@ -680,6 +744,45 @@ components: request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled]. type: string type: object + ForwardRequest: + additionalProperties: false + properties: + baseUrl: + description: The base url to forward the request + type: string + merchantAccount: + description: The merchant account code + type: string + request: + description: The details of the request to be sent + $ref: '#/components/schemas/OutgoingForwardRequest' + shopperReference: + description: The shopper reference + type: string + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token or it is passed by the account to find the + existing recurring details + type: string + required: + - merchantAccount + - shopperReference + - storedPaymentMethodId + - baseUrl + - request + type: object + ForwardResponse: + additionalProperties: false + properties: + response: + description: 'The details of the from the forwarded party ' + $ref: '#/components/schemas/ThirdPartyForwardResponse' + storedPaymentMethodId: + description: Recurring Detail Reference + type: string + required: + - response + type: object Name: additionalProperties: false properties: @@ -769,6 +872,35 @@ components: when token was created type: string type: object + OutgoingForwardRequest: + additionalProperties: false + properties: + body: + description: The body of the http request to be sent + type: string + credentials: + description: 'The credentials needed to authenticate on the third party ' + type: string + headers: + additionalProperties: + type: string + description: The headers that the request will be sent with. Supports the + placeholder `{{credentials}}` + type: object + httpMethod: + description: The http method that the request will be sent via + enum: + - POST + - PUT + - PATCH + type: string + urlSuffix: + description: The path that the request will be sent to + type: string + required: + - httpMethod + - body + type: object Permit: additionalProperties: false properties: @@ -1088,6 +1220,22 @@ components: format: int32 type: integer type: object + ThirdPartyForwardResponse: + additionalProperties: false + properties: + body: + description: Body of the response from the forwarded party + type: string + headers: + additionalProperties: + type: string + description: Http headers of the response from the forwarded party + type: object + status: + description: Http status of the response from the forwarded party + format: int32 + type: integer + type: object TokenDetails: additionalProperties: false properties: @@ -1152,6 +1300,11 @@ components: expiryYear: '2030' holderName: Adyen Test number: '4111111111111111' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData-200: + summary: Scheduled Account Updater with card data + value: + pspReference: QFQTPCQ8HXSKGK82 + result: Success post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData: summary: Schedule AccountUpdater with token data value: @@ -1159,3 +1312,15 @@ components: reference: YOUR_REFERENCE shopperReference: YOUR_SHOPPER_REFERENCE selectedRecurringDetailReference: '8814232895168272' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-200: + summary: Scheduled Account Updater with token data + value: + pspReference: JLCMPCQ8HXSKGK82 + result: Success + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData-422: + summary: Error response for RecurringShopper not found + value: + status: 422 + errorCode: '000' + message: RecurringShopper not found + errorType: validation