mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
Updated Checkout specs
This commit is contained in:
@@ -9,7 +9,7 @@
|
||||
"version" : "37",
|
||||
"title" : "Adyen Checkout Service",
|
||||
"description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including One-Click and 3D Secure), mobile wallets, and local payment methods (e.g. iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/developers/checkout).\n\n## Authentication\nEach request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/developers/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_Checkout_API_key\" \\\n...\n```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/developers/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports versioning of its endpoints through 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://checkout-test.adyen.com/v37/payments\n```",
|
||||
"termsOfService" : "https://docs.adyen.com/legal/terms-conditions",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Support",
|
||||
"url" : "https://support.adyen.com/",
|
||||
@@ -17,8 +17,8 @@
|
||||
}
|
||||
},
|
||||
"x-groups" : [
|
||||
"SDK Integration",
|
||||
"API Integration"
|
||||
"API Integration",
|
||||
"SDK Integration"
|
||||
],
|
||||
"paths" : {
|
||||
"/paymentMethods" : {
|
||||
@@ -68,7 +68,7 @@
|
||||
"/paymentSession" : {
|
||||
"post" : {
|
||||
"summary" : "Creates a payment session.",
|
||||
"description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).",
|
||||
"description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/developers/checkout#howitworks).",
|
||||
"x-groupName" : "SDK Integration",
|
||||
"x-sortIndex" : 1,
|
||||
"requestBody" : {
|
||||
@@ -200,7 +200,7 @@
|
||||
"/payments/result" : {
|
||||
"post" : {
|
||||
"summary" : "Verifies payment result.",
|
||||
"description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).",
|
||||
"description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/developers/checkout#howitworks).",
|
||||
"x-groupName" : "SDK Integration",
|
||||
"x-sortIndex" : 2,
|
||||
"requestBody" : {
|
||||
@@ -386,7 +386,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"expiryYear" : {
|
||||
"description" : "The card expiry year.\nFormat: 4 digits. For example: 2018",
|
||||
"description" : "The card expiry year.\nFormat: 4 digits. For example: 2020",
|
||||
"maxLength" : 4,
|
||||
"minLength" : 4,
|
||||
"type" : "string"
|
||||
@@ -879,7 +879,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"splits" : {
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.",
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/Split"
|
||||
},
|
||||
@@ -1109,7 +1109,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"splits" : {
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.",
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/Split"
|
||||
},
|
||||
@@ -1317,7 +1317,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"origin" : {
|
||||
"description" : "Required for the Web integration.\n\nSet this parameter to the page URL, on which you are loading the SDK.",
|
||||
"description" : "Required for the Web integration.\n\nSet this parameter to the origin URL of the page that you are loading the SDK from.",
|
||||
"type" : "string"
|
||||
},
|
||||
"reference" : {
|
||||
@@ -1375,7 +1375,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"splits" : {
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.",
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/Split"
|
||||
},
|
||||
|
||||
@@ -27,14 +27,14 @@ info:
|
||||
```
|
||||
https://checkout-test.adyen.com/v37/payments
|
||||
```
|
||||
termsOfService: 'https://docs.adyen.com/legal/terms-conditions'
|
||||
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
|
||||
contact:
|
||||
name: Adyen Support
|
||||
url: 'https://support.adyen.com/'
|
||||
email: support@adyen.com
|
||||
x-groups:
|
||||
- SDK Integration
|
||||
- API Integration
|
||||
- SDK Integration
|
||||
paths:
|
||||
/paymentMethods:
|
||||
post:
|
||||
@@ -73,7 +73,7 @@ paths:
|
||||
description: |-
|
||||
Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.
|
||||
|
||||
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).
|
||||
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout#howitworks).
|
||||
x-groupName: SDK Integration
|
||||
x-sortIndex: 1
|
||||
requestBody:
|
||||
@@ -168,7 +168,7 @@ paths:
|
||||
description: |-
|
||||
Verifies the payment result using the payload returned from the Checkout SDK.
|
||||
|
||||
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).
|
||||
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout#howitworks).
|
||||
x-groupName: SDK Integration
|
||||
x-sortIndex: 2
|
||||
requestBody:
|
||||
@@ -348,7 +348,7 @@ components:
|
||||
expiryYear:
|
||||
description: |-
|
||||
The card expiry year.
|
||||
Format: 4 digits. For example: 2018
|
||||
Format: 4 digits. For example: 2020
|
||||
maxLength: 4
|
||||
minLength: 4
|
||||
type: string
|
||||
@@ -733,7 +733,7 @@ components:
|
||||
> This field is required for recurring payments.
|
||||
type: string
|
||||
splits:
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.
|
||||
items:
|
||||
$ref: '#/components/schemas/Split'
|
||||
type: array
|
||||
@@ -948,7 +948,7 @@ components:
|
||||
description: The shopper's social security number.
|
||||
type: string
|
||||
splits:
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.
|
||||
items:
|
||||
$ref: '#/components/schemas/Split'
|
||||
type: array
|
||||
@@ -1150,7 +1150,7 @@ components:
|
||||
description: |-
|
||||
Required for the Web integration.
|
||||
|
||||
Set this parameter to the page URL, on which you are loading the SDK.
|
||||
Set this parameter to the origin URL of the page that you are loading the SDK from.
|
||||
type: string
|
||||
reference:
|
||||
description: |-
|
||||
@@ -1209,7 +1209,7 @@ components:
|
||||
description: The shopper's social security number.
|
||||
type: string
|
||||
splits:
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.
|
||||
items:
|
||||
$ref: '#/components/schemas/Split'
|
||||
type: array
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"version" : "40",
|
||||
"title" : "Adyen Checkout Service",
|
||||
"description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including One-Click and 3D Secure), mobile wallets, and local payment methods (e.g. iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/developers/checkout).\n\n## Authentication\nEach request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/developers/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_Checkout_API_key\" \\\n...\n```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/developers/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports versioning of its endpoints through 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://checkout-test.adyen.com/v40/payments\n```",
|
||||
"termsOfService" : "https://docs.adyen.com/legal/terms-conditions",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Support",
|
||||
"url" : "https://support.adyen.com/",
|
||||
@@ -17,8 +17,8 @@
|
||||
}
|
||||
},
|
||||
"x-groups" : [
|
||||
"SDK Integration",
|
||||
"API Integration"
|
||||
"API Integration",
|
||||
"SDK Integration"
|
||||
],
|
||||
"paths" : {
|
||||
"/paymentMethods" : {
|
||||
@@ -68,7 +68,7 @@
|
||||
"/paymentSession" : {
|
||||
"post" : {
|
||||
"summary" : "Creates a payment session.",
|
||||
"description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).",
|
||||
"description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/developers/checkout#howitworks).",
|
||||
"x-groupName" : "SDK Integration",
|
||||
"x-sortIndex" : 1,
|
||||
"requestBody" : {
|
||||
@@ -156,7 +156,7 @@
|
||||
"/payments/details" : {
|
||||
"post" : {
|
||||
"summary" : "Submits details for a payment.",
|
||||
"description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request (for example for 3D Secure, or when getting redirected back directly from a payment method using an app switch).\n\nThe exact details, which need to be sent to this endpoint, are always specified in the response of the associated `/payments` request. When sending in the request to `/payments/details`, make sure you send the corresponding `paymentData` as obtained during the `/payments` call.\n\nIn addition, the endpoint can be used to verify a `payload`, which is returned after coming back from the Checkout SDK or any of the redirect based methods on the Checkout API.",
|
||||
"description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request (for example for 3D Secure, or when getting redirected back directly from a payment method using an app switch).\n\nThe exact details, which need to be sent to this endpoint, are always specified in the response of the associated `/payments` request.\n\nIn addition, the endpoint can be used to verify a `payload`, which is returned after coming back from the Checkout SDK or any of the redirect based methods on the Checkout API.",
|
||||
"x-groupName" : "API Integration",
|
||||
"x-sortIndex" : 3,
|
||||
"requestBody" : {
|
||||
@@ -200,7 +200,7 @@
|
||||
"/payments/result" : {
|
||||
"post" : {
|
||||
"summary" : "Verifies payment result.",
|
||||
"description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).",
|
||||
"description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/developers/checkout#howitworks).",
|
||||
"x-groupName" : "SDK Integration",
|
||||
"x-sortIndex" : 2,
|
||||
"requestBody" : {
|
||||
@@ -532,7 +532,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"expiryYear" : {
|
||||
"description" : "The card expiry year.\nFormat: 4 digits. For example: 2018",
|
||||
"description" : "The card expiry year.\nFormat: 4 digits. For example: 2020",
|
||||
"maxLength" : 4,
|
||||
"minLength" : 4,
|
||||
"type" : "string"
|
||||
@@ -640,37 +640,9 @@
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"details",
|
||||
"paymentData"
|
||||
"details"
|
||||
]
|
||||
},
|
||||
"DeviceRenderOptions" : {
|
||||
"properties" : {
|
||||
"sdkInterface" : {
|
||||
"description" : "Supported SDK interface types.",
|
||||
"enum" : [
|
||||
"Html",
|
||||
"Native",
|
||||
"both"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"sdkUiType" : {
|
||||
"description" : "UI types supported for displaying specific challenges.",
|
||||
"items" : {
|
||||
"enum" : [
|
||||
"multiSelect",
|
||||
"otherHtml",
|
||||
"outOfBand",
|
||||
"singleSelect",
|
||||
"text"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : "array"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ForexQuote" : {
|
||||
"properties" : {
|
||||
"account" : {
|
||||
@@ -1332,7 +1304,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"splits" : {
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.",
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/Split"
|
||||
},
|
||||
@@ -1376,6 +1348,10 @@
|
||||
"description" : "The fraud result properties of the payment.",
|
||||
"$ref" : "#/components/schemas/FraudResult"
|
||||
},
|
||||
"outputDetails" : {
|
||||
"description" : "Contains the details that will be presented to the shopper.",
|
||||
"type" : "object"
|
||||
},
|
||||
"paymentData" : {
|
||||
"description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint.",
|
||||
"type" : "string"
|
||||
@@ -1540,7 +1516,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"origin" : {
|
||||
"description" : "Required for the Web integration.\n\nSet this parameter to the page URL, on which you are loading the SDK.",
|
||||
"description" : "Required for the Web integration.\n\nSet this parameter to the origin URL of the page that you are loading the SDK from.",
|
||||
"type" : "string"
|
||||
},
|
||||
"reference" : {
|
||||
@@ -1598,7 +1574,7 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"splits" : {
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.",
|
||||
"description" : "The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/Split"
|
||||
},
|
||||
@@ -1799,26 +1775,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"SDKEphemPubKey" : {
|
||||
"properties" : {
|
||||
"crv" : {
|
||||
"description" : "The `crv` value as received from the 3D Secure 2.0 SDK.",
|
||||
"type" : "string"
|
||||
},
|
||||
"kty" : {
|
||||
"description" : "The `kty` value as received from the 3D Secure 2.0 SDK.",
|
||||
"type" : "string"
|
||||
},
|
||||
"x" : {
|
||||
"description" : "The `x` value as received from the 3D Secure 2.0 SDK.",
|
||||
"type" : "string"
|
||||
},
|
||||
"y" : {
|
||||
"description" : "The `y` value as received from the 3D Secure 2.0 SDK.",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ServiceError" : {
|
||||
"properties" : {
|
||||
"errorCode" : {
|
||||
@@ -1984,13 +1940,10 @@
|
||||
"type" : "string"
|
||||
},
|
||||
"threeDSRequestorURL" : {
|
||||
"description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3DS2.0 process.",
|
||||
"description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3DS 2.0 process.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"required" : [
|
||||
"deviceChannel"
|
||||
]
|
||||
}
|
||||
},
|
||||
"ThreeDSecureData" : {
|
||||
"properties" : {
|
||||
@@ -2040,4 +1993,4 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -27,14 +27,14 @@ info:
|
||||
```
|
||||
https://checkout-test.adyen.com/v40/payments
|
||||
```
|
||||
termsOfService: 'https://docs.adyen.com/legal/terms-conditions'
|
||||
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
|
||||
contact:
|
||||
name: Adyen Support
|
||||
url: 'https://support.adyen.com/'
|
||||
email: support@adyen.com
|
||||
x-groups:
|
||||
- SDK Integration
|
||||
- API Integration
|
||||
- SDK Integration
|
||||
paths:
|
||||
/paymentMethods:
|
||||
post:
|
||||
@@ -73,7 +73,7 @@ paths:
|
||||
description: |-
|
||||
Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.
|
||||
|
||||
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).
|
||||
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout#howitworks).
|
||||
x-groupName: SDK Integration
|
||||
x-sortIndex: 1
|
||||
requestBody:
|
||||
@@ -135,7 +135,7 @@ paths:
|
||||
description: |-
|
||||
Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request (for example for 3D Secure, or when getting redirected back directly from a payment method using an app switch).
|
||||
|
||||
The exact details, which need to be sent to this endpoint, are always specified in the response of the associated `/payments` request. When sending in the request to `/payments/details`, make sure you send the corresponding `paymentData` as obtained during the `/payments` call.
|
||||
The exact details, which need to be sent to this endpoint, are always specified in the response of the associated `/payments` request.
|
||||
|
||||
In addition, the endpoint can be used to verify a `payload`, which is returned after coming back from the Checkout SDK or any of the redirect based methods on the Checkout API.
|
||||
x-groupName: API Integration
|
||||
@@ -168,7 +168,7 @@ paths:
|
||||
description: |-
|
||||
Verifies the payment result using the payload returned from the Checkout SDK.
|
||||
|
||||
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout/integrations-overview#howitworks).
|
||||
For more information, refer to [How it works](https://docs.adyen.com/developers/checkout#howitworks).
|
||||
x-groupName: SDK Integration
|
||||
x-sortIndex: 2
|
||||
requestBody:
|
||||
@@ -463,7 +463,7 @@ components:
|
||||
expiryYear:
|
||||
description: |-
|
||||
The card expiry year.
|
||||
Format: 4 digits. For example: 2018
|
||||
Format: 4 digits. For example: 2020
|
||||
maxLength: 4
|
||||
minLength: 4
|
||||
type: string
|
||||
@@ -553,27 +553,6 @@ components:
|
||||
type: string
|
||||
required:
|
||||
- details
|
||||
- paymentData
|
||||
DeviceRenderOptions:
|
||||
properties:
|
||||
sdkInterface:
|
||||
description: Supported SDK interface types.
|
||||
enum:
|
||||
- Html
|
||||
- Native
|
||||
- both
|
||||
type: string
|
||||
sdkUiType:
|
||||
description: UI types supported for displaying specific challenges.
|
||||
items:
|
||||
enum:
|
||||
- multiSelect
|
||||
- otherHtml
|
||||
- outOfBand
|
||||
- singleSelect
|
||||
- text
|
||||
type: string
|
||||
type: array
|
||||
ForexQuote:
|
||||
properties:
|
||||
account:
|
||||
@@ -1122,7 +1101,7 @@ components:
|
||||
description: The shopper's social security number.
|
||||
type: string
|
||||
splits:
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.
|
||||
items:
|
||||
$ref: '#/components/schemas/Split'
|
||||
type: array
|
||||
@@ -1154,6 +1133,9 @@ components:
|
||||
fraudResult:
|
||||
description: The fraud result properties of the payment.
|
||||
$ref: '#/components/schemas/FraudResult'
|
||||
outputDetails:
|
||||
description: Contains the details that will be presented to the shopper.
|
||||
type: object
|
||||
paymentData:
|
||||
description: 'When non-empty, contains a value that you must submit to the `/payments/details` endpoint.'
|
||||
type: string
|
||||
@@ -1321,7 +1303,7 @@ components:
|
||||
description: |-
|
||||
Required for the Web integration.
|
||||
|
||||
Set this parameter to the page URL, on which you are loading the SDK.
|
||||
Set this parameter to the origin URL of the page that you are loading the SDK from.
|
||||
type: string
|
||||
reference:
|
||||
description: |-
|
||||
@@ -1380,7 +1362,7 @@ components:
|
||||
description: The shopper's social security number.
|
||||
type: string
|
||||
splits:
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.
|
||||
description: The details of how the payment should be split when distributing a payment to a MarketPay platform and its Accounts.
|
||||
items:
|
||||
$ref: '#/components/schemas/Split'
|
||||
type: array
|
||||
@@ -1552,20 +1534,6 @@ components:
|
||||
url:
|
||||
description: 'The URL, to which you must redirect a shopper to complete a payment.'
|
||||
type: string
|
||||
SDKEphemPubKey:
|
||||
properties:
|
||||
crv:
|
||||
description: The `crv` value as received from the 3D Secure 2.0 SDK.
|
||||
type: string
|
||||
kty:
|
||||
description: The `kty` value as received from the 3D Secure 2.0 SDK.
|
||||
type: string
|
||||
x:
|
||||
description: The `x` value as received from the 3D Secure 2.0 SDK.
|
||||
type: string
|
||||
'y':
|
||||
description: The `y` value as received from the 3D Secure 2.0 SDK.
|
||||
type: string
|
||||
ServiceError:
|
||||
properties:
|
||||
errorCode:
|
||||
@@ -1721,10 +1689,8 @@ components:
|
||||
Only for `deviceChannel` set to **browser**.
|
||||
type: string
|
||||
threeDSRequestorURL:
|
||||
description: URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3DS2.0 process.
|
||||
description: URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3DS 2.0 process.
|
||||
type: string
|
||||
required:
|
||||
- deviceChannel
|
||||
ThreeDSecureData:
|
||||
properties:
|
||||
authenticationResponse:
|
||||
|
||||
2111
specs/3.0/CheckoutService-v41.json
Normal file
2111
specs/3.0/CheckoutService-v41.json
Normal file
File diff suppressed because it is too large
Load Diff
1899
specs/3.0/CheckoutService-v41.yaml
Normal file
1899
specs/3.0/CheckoutService-v41.yaml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -8,8 +8,8 @@
|
||||
"info" : {
|
||||
"version" : "1",
|
||||
"title" : "Adyen Checkout Utility Service",
|
||||
"description" : "A web service containing utility functions available for merchants integrating with Checkout APIs.\n## Authentication\nEach request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the Checkout API key](https://docs.adyen.com/developers/user-management/how-to-get-the-checkout-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_Checkout_API_key\" \\\n...\n```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/developers/api-reference/live-endpoints).\n\n## Versioning\nCheckout API supports versioning of its endpoints through 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://checkout-test.adyen.com/v1/originKeys\n```",
|
||||
"termsOfService" : "https://docs.adyen.com/legal/terms-conditions",
|
||||
"description" : "A web service containing utility functions available for merchants integrating with Checkout APIs.\n## Authentication\nEach request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/developers/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_Checkout_API_key\" \\\n...\n```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/developers/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports versioning of its endpoints through 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://checkout-test.adyen.com/v1/originKeys\n```",
|
||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||
"contact" : {
|
||||
"name" : "Adyen Support",
|
||||
"url" : "https://support.adyen.com/",
|
||||
@@ -84,9 +84,6 @@
|
||||
"CheckoutUtilityResponse" : {
|
||||
"properties" : {
|
||||
"originKeys" : {
|
||||
"additionalProperties" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.",
|
||||
"type" : "object"
|
||||
}
|
||||
@@ -94,4 +91,4 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -7,7 +7,7 @@ info:
|
||||
description: |-
|
||||
A web service containing utility functions available for merchants integrating with Checkout APIs.
|
||||
## Authentication
|
||||
Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the Checkout API key](https://docs.adyen.com/developers/user-management/how-to-get-the-checkout-api-key). Then set this key to the `X-API-Key` header value, for example:
|
||||
Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/developers/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example:
|
||||
|
||||
```
|
||||
curl
|
||||
@@ -15,7 +15,7 @@ info:
|
||||
-H "X-API-Key: Your_Checkout_API_key" \
|
||||
...
|
||||
```
|
||||
Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/developers/api-reference/live-endpoints).
|
||||
Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/developers/development-resources/live-endpoints).
|
||||
|
||||
## Versioning
|
||||
Checkout API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
|
||||
@@ -24,7 +24,7 @@ info:
|
||||
```
|
||||
https://checkout-test.adyen.com/v1/originKeys
|
||||
```
|
||||
termsOfService: 'https://docs.adyen.com/legal/terms-conditions'
|
||||
termsOfService: 'https://www.adyen.com/legal/terms-and-conditions'
|
||||
contact:
|
||||
name: Adyen Support
|
||||
url: 'https://support.adyen.com/'
|
||||
@@ -74,7 +74,5 @@ components:
|
||||
CheckoutUtilityResponse:
|
||||
properties:
|
||||
originKeys:
|
||||
additionalProperties:
|
||||
type: string
|
||||
description: 'The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.'
|
||||
type: object
|
||||
|
||||
Reference in New Issue
Block a user