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

spec release

Browse Source
This commit is contained in:
Adyen Automation
2023-05-31 10:23:54 +00:00
parent 39cbe6f0aa
commit 943296e939
2 changed files with 36 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
json/PaymentService-v68.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Adyen Payment API",
"description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments 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/Payment/v68/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.",
"x-timestamp" : "2023-05-30T15:27:08Z",
"x-timestamp" : "2023-05-30T22:26:22Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -2858,7 +2858,7 @@
},
"platformChargebackLogic" : {
"x-addedInVersion" : "68",
"description" : "Defines the behavior to be applied in case of a chargeback.",
"description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
"$ref" : "#/components/schemas/PlatformChargebackLogic"
},
"reference" : {
@@ -3155,7 +3155,7 @@
},
"platformChargebackLogic" : {
"x-addedInVersion" : "68",
"description" : "Defines the behavior to be applied in case of a chargeback.",
"description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
"$ref" : "#/components/schemas/PlatformChargebackLogic"
},
"reference" : {
@@ -3258,7 +3258,7 @@
},
"platformChargebackLogic" : {
"x-addedInVersion" : "68",
"description" : "Defines the behavior to be applied in case of a chargeback.",
"description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
"$ref" : "#/components/schemas/PlatformChargebackLogic"
},
"reference" : {
@@ -3373,7 +3373,7 @@
},
"platformChargebackLogic" : {
"x-addedInVersion" : "68",
"description" : "Defines the behavior to be applied in case of a chargeback.",
"description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
"$ref" : "#/components/schemas/PlatformChargebackLogic"
},
"reference" : {
@@ -3521,7 +3521,7 @@
},
"platformChargebackLogic" : {
"x-addedInVersion" : "68",
"description" : "Defines the behavior to be applied in case of a chargeback.",
"description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
"$ref" : "#/components/schemas/PlatformChargebackLogic"
},
"reference" : {
@@ -4192,7 +4192,7 @@
},
"platformChargebackLogic" : {
"x-addedInVersion" : "68",
"description" : "Defines the behavior to be applied in case of a chargeback.",
"description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
"$ref" : "#/components/schemas/PlatformChargebackLogic"
},
"recurring" : {
@@ -5019,6 +5019,7 @@
"properties" : {
"behavior" : {
"x-addedInVersion" : "68",
"description" : "The method of handling the chargeback.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.",
"enum" : [
"deductAccordingToSplitRatio",
"deductFromLiableAccount",
@@ -5028,10 +5029,12 @@
},
"costAllocationAccount" : {
"x-addedInVersion" : "68",
"description" : "The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account.",
"type" : "string"
},
"targetAccount" : {
"x-addedInVersion" : "68",
"description" : "The unique identifier of the balance account against which the disputed amount is booked.\n\nRequired if `behavior` is **deductFromOneBalanceAccount**.",
"type" : "string"
}
},
@@ -5158,7 +5161,7 @@
},
"platformChargebackLogic" : {
"x-addedInVersion" : "68",
"description" : "Defines the behavior to be applied in case of a chargeback.",
"description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
"$ref" : "#/components/schemas/PlatformChargebackLogic"
},
"reference" : {
@@ -5875,7 +5878,7 @@
},
"platformChargebackLogic" : {
"x-addedInVersion" : "68",
"description" : "Defines the behavior to be applied in case of a chargeback.",
"description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
"$ref" : "#/components/schemas/PlatformChargebackLogic"
},
"reference" : {
@@ -6552,7 +6555,7 @@
},
"platformChargebackLogic" : {
"x-addedInVersion" : "68",
"description" : "Defines the behavior to be applied in case of a chargeback.",
"description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
"$ref" : "#/components/schemas/PlatformChargebackLogic"
},
"reference" : {

33
yaml/PaymentService-v68.yaml
View File

@@ -25,7 +25,7 @@ info:
\ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise\n\
```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\
\ **API URLs** > **Prefix**."
x-timestamp: '2023-05-30T15:27:08Z'
x-timestamp: '2023-05-30T22:26:22Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -3144,7 +3144,7 @@ components:
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines the behavior to be applied in case of a chargeback.
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
reference:
description: 'Your reference for the payment modification. This reference
@@ -3401,7 +3401,7 @@ components:
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines the behavior to be applied in case of a chargeback.
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
reference:
description: 'Your reference for the payment modification. This reference
@@ -3478,7 +3478,7 @@ components:
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines the behavior to be applied in case of a chargeback.
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
reference:
description: 'Your reference for the payment modification. This reference
@@ -3568,7 +3568,7 @@ components:
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines the behavior to be applied in case of a chargeback.
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
reference:
description: 'Your reference for the payment modification. This reference
@@ -3741,7 +3741,7 @@ components:
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines the behavior to be applied in case of a chargeback.
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
reference:
description: 'Your reference for the payment modification. This reference
@@ -4415,7 +4415,7 @@ components:
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines the behavior to be applied in case of a chargeback.
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
recurring:
description: The recurring settings for the payment. Use this property when
@@ -5471,6 +5471,11 @@ components:
properties:
behavior:
x-addedInVersion: '68'
description: 'The method of handling the chargeback.
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**,
**deductAccordingToSplitRatio**.'
enum:
- deductAccordingToSplitRatio
- deductFromLiableAccount
@@ -5478,9 +5483,17 @@ components:
type: string
costAllocationAccount:
x-addedInVersion: '68'
description: The unique identifier of the balance account to which the chargeback
fees are booked. By default, the chargeback fees are booked to your liable
balance account.
type: string
targetAccount:
x-addedInVersion: '68'
description: 'The unique identifier of the balance account against which
the disputed amount is booked.
Required if `behavior` is **deductFromOneBalanceAccount**.'
type: string
type: object
Recurring:
@@ -5581,7 +5594,7 @@ components:
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines the behavior to be applied in case of a chargeback.
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
reference:
description: 'Your reference for the payment modification. This reference
@@ -6475,7 +6488,7 @@ components:
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines the behavior to be applied in case of a chargeback.
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
reference:
description: 'Your reference for the payment modification. This reference
@@ -7161,7 +7174,7 @@ components:
type: string
platformChargebackLogic:
x-addedInVersion: '68'
description: Defines the behavior to be applied in case of a chargeback.
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
$ref: '#/components/schemas/PlatformChargebackLogic'
reference:
description: 'Your reference for the payment modification. This reference