mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
Updated JSON specs
This commit is contained in:
aleksei
@@ -63,7 +63,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"adjustAuthorisation" : {
|
||||
"$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation"
|
||||
"$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -78,7 +78,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -93,7 +93,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -128,7 +128,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -206,7 +206,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -221,7 +221,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -256,7 +256,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -319,7 +319,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -334,7 +334,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -369,7 +369,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -432,7 +432,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -447,7 +447,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -482,7 +482,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -535,7 +535,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"cancelOrRefund" : {
|
||||
"$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund"
|
||||
"$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -550,7 +550,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -565,7 +565,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -600,7 +600,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -653,7 +653,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"capture" : {
|
||||
"$ref" : "#/components/examples/post-capture-capture"
|
||||
"$ref" : "#/components/examples/post-capture-capture-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -668,7 +668,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -683,7 +683,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -718,7 +718,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -771,7 +771,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"refund" : {
|
||||
"$ref" : "#/components/examples/post-refund-refund"
|
||||
"$ref" : "#/components/examples/post-refund-refund-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -786,7 +786,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -801,7 +801,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -836,7 +836,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -890,7 +890,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"technicalCancel" : {
|
||||
"$ref" : "#/components/examples/post-technicalCancel-technicalCancel"
|
||||
"$ref" : "#/components/examples/post-technicalCancel-technicalCancel-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -905,7 +905,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -920,7 +920,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -955,7 +955,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -1012,10 +1012,10 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"voidpendingrefund-pspreference" : {
|
||||
"$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference"
|
||||
"$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200"
|
||||
},
|
||||
"voidpendingrefund-tenderreference" : {
|
||||
"$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference"
|
||||
"$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -1030,7 +1030,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-400"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -1045,7 +1045,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-401"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -1080,7 +1080,7 @@
|
||||
"application/json" : {
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"$ref" : "#/components/examples/generic"
|
||||
"$ref" : "#/components/examples/generic-500"
|
||||
}
|
||||
},
|
||||
"schema" : {
|
||||
@@ -1103,7 +1103,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"executeThreeD" : {
|
||||
"description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication.\n",
|
||||
"description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n",
|
||||
"type" : "string"
|
||||
},
|
||||
"mpiImplementationType" : {
|
||||
@@ -3268,9 +3268,6 @@
|
||||
{
|
||||
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
|
||||
},
|
||||
{
|
||||
"$ref" : "#/components/schemas/ResponseAdditionalDataSepa"
|
||||
}
|
||||
@@ -3741,6 +3738,14 @@
|
||||
"description" : "Raw refusal reason received from the acquirer, where available.\n\nExample: AUTHORISED",
|
||||
"type" : "string"
|
||||
},
|
||||
"requestAmount" : {
|
||||
"description" : "The amount of the payment request.",
|
||||
"type" : "string"
|
||||
},
|
||||
"requestCurrencyCode" : {
|
||||
"description" : "The currency of the payment request.",
|
||||
"type" : "string"
|
||||
},
|
||||
"shopperInteraction" : {
|
||||
"description" : "The shopper interaction type of the payment request.\n\nExample: Ecommerce",
|
||||
"type" : "string"
|
||||
@@ -3887,30 +3892,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"ResponseAdditionalDataPayPal" : {
|
||||
"properties" : {
|
||||
"paypalEmail" : {
|
||||
"description" : "The buyer's PayPal account email address.\n\nExample: paypaltest@adyen.com",
|
||||
"type" : "string"
|
||||
},
|
||||
"paypalPayerId" : {
|
||||
"description" : "The buyer's PayPal ID.\n\nExample: LF5HCWWBRV2KL",
|
||||
"type" : "string"
|
||||
},
|
||||
"paypalPayerResidenceCountry" : {
|
||||
"description" : "The buyer's country of residence.\n\nExample: NL",
|
||||
"type" : "string"
|
||||
},
|
||||
"paypalPayerStatus" : {
|
||||
"description" : "The status of the buyer's PayPal account.\n\nExample: unverified",
|
||||
"type" : "string"
|
||||
},
|
||||
"paypalProtectionEligibility" : {
|
||||
"description" : "The eligibility for PayPal Seller Protection for this payment.\n\nExample: Ineligible",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ResponseAdditionalDataSepa" : {
|
||||
"properties" : {
|
||||
"sepadirectdebit.dateOfSignature" : {
|
||||
@@ -4198,7 +4179,16 @@
|
||||
}
|
||||
},
|
||||
"examples" : {
|
||||
"generic" : {
|
||||
"generic-400" : {
|
||||
"summary" : "Response code 400. Bad request.",
|
||||
"value" : {
|
||||
"status" : 400,
|
||||
"errorCode" : "702",
|
||||
"message" : "Unexpected input: \", expected: }",
|
||||
"errorType" : "validation"
|
||||
}
|
||||
},
|
||||
"generic-401" : {
|
||||
"summary" : "Response code 401. Unauthorized.",
|
||||
"value" : {
|
||||
"status" : 401,
|
||||
@@ -4207,6 +4197,16 @@
|
||||
"errorType" : "security"
|
||||
}
|
||||
},
|
||||
"generic-500" : {
|
||||
"summary" : "Response code 500. Internal server error.",
|
||||
"value" : {
|
||||
"status" : 500,
|
||||
"errorCode" : "905",
|
||||
"message" : "Payment details are not supported",
|
||||
"errorType" : "configuration",
|
||||
"pspReference" : "8516091485743033"
|
||||
}
|
||||
},
|
||||
"post-adjustAuthorisation-adjustAuthorisation" : {
|
||||
"summary" : "Increases or decreases the authorised amount",
|
||||
"value" : {
|
||||
@@ -4219,6 +4219,13 @@
|
||||
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
|
||||
}
|
||||
},
|
||||
"post-adjustAuthorisation-adjustAuthorisation-200" : {
|
||||
"summary" : "Example response for request 'adjustAuthorisation'",
|
||||
"value" : {
|
||||
"pspReference" : "851617892360718D",
|
||||
"response" : "[adjustAuthorisation-received]"
|
||||
}
|
||||
},
|
||||
"post-authorise-authorise-3dsecure" : {
|
||||
"summary" : "Initiate a 3D Secure payment",
|
||||
"value" : {
|
||||
@@ -4381,6 +4388,13 @@
|
||||
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
|
||||
}
|
||||
},
|
||||
"post-cancelOrRefund-cancelOrRefund-200" : {
|
||||
"summary" : "Example response for request 'cancelOrRefund'",
|
||||
"value" : {
|
||||
"pspReference" : "851617892359708H",
|
||||
"response" : "[cancelOrRefund-received]"
|
||||
}
|
||||
},
|
||||
"post-capture-capture" : {
|
||||
"summary" : "Capture an authorised payment",
|
||||
"value" : {
|
||||
@@ -4393,6 +4407,13 @@
|
||||
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
|
||||
}
|
||||
},
|
||||
"post-capture-capture-200" : {
|
||||
"summary" : "Example response for request 'capture'",
|
||||
"value" : {
|
||||
"pspReference" : "861617892359057J",
|
||||
"response" : "[capture-received]"
|
||||
}
|
||||
},
|
||||
"post-refund-refund" : {
|
||||
"summary" : "Refund a captured payment",
|
||||
"value" : {
|
||||
@@ -4405,7 +4426,22 @@
|
||||
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
|
||||
}
|
||||
},
|
||||
"post-refund-refund-200" : {
|
||||
"summary" : "Example response for request 'refund'",
|
||||
"value" : {
|
||||
"pspReference" : "861617892360059B",
|
||||
"response" : "[refund-received]"
|
||||
}
|
||||
},
|
||||
"post-technicalCancel-technicalCancel" : {
|
||||
"summary" : "Cancel a payment without a PSP reference",
|
||||
"value" : {
|
||||
"originalMerchantReference" : "YOUR_MERCHANT_REFERENCE",
|
||||
"reference" : "YOUR_MODIFICATION_REFERENCE",
|
||||
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
|
||||
}
|
||||
},
|
||||
"post-technicalCancel-technicalCancel-200" : {
|
||||
"summary" : "Example response for request 'technicalCancel'",
|
||||
"value" : {
|
||||
"pspReference" : "881617892361436J",
|
||||
@@ -4419,7 +4455,22 @@
|
||||
"originalReference" : "9914748988390044"
|
||||
}
|
||||
},
|
||||
"post-voidPendingRefund-voidpendingrefund-pspreference-200" : {
|
||||
"summary" : "Example response for request 'voidpendingrefund-pspreference'",
|
||||
"value" : {
|
||||
"pspReference" : "861617892360062F",
|
||||
"response" : "[voidPendingRefund-received]"
|
||||
}
|
||||
},
|
||||
"post-voidPendingRefund-voidpendingrefund-tenderreference" : {
|
||||
"summary" : "Cancels a POS refund request with tender reference before it has been completed",
|
||||
"value" : {
|
||||
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
|
||||
"tenderReference" : "5Iw8001176969533005",
|
||||
"uniqueTerminalId" : "VX820-123456789"
|
||||
}
|
||||
},
|
||||
"post-voidPendingRefund-voidpendingrefund-tenderreference-200" : {
|
||||
"summary" : "Example response for request 'voidpendingrefund-tenderreference'",
|
||||
"value" : {
|
||||
"pspReference" : "881617892360409G",
|
||||
|
||||
Reference in New Issue
Block a user