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-11-06 14:13:38 +01:00
parent 5b3e4befdc
commit b774d3cc58
4 changed files with 214 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
json/ManagementService-v1.json
View File

@@ -9,7 +9,7 @@
"version" : "1",
"x-publicVersion" : true,
"title" : "Management API",
"description" : "Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.\n## Authentication\nEach request to the Management API must be signed with an API key. [Generate your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) in the Customer Area and then set this key to the `X-API-Key` header value.\n\nTo access the live endpoints, you need to generate a new API key in your live Customer Area.\n## Versioning\n\nManagement API handles versioning as part of the endpoint URL. For example, to send a request to version 1 of the `/companies/{companyId}/webhooks` endpoint, use:\n\n```text\nhttps://management-test.adyen.com/v1/companies/{companyId}/webhooks\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area. Use this API key to make requests to:\n\n```text\nhttps://management-live.adyen.com/v1\n```",
"description" : "Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.\n## Authentication\nEach request to the Management API must be signed with an API key. [Generate your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) in the Customer Area and then set this key to the `X-API-Key` header value.\n\nTo access the live endpoints, you need to generate a new API key in your live Customer Area.\n## Versioning\n\nManagement API handles versioning as part of the endpoint URL. For example, to send a request to this version of the `/companies/{companyId}/webhooks` endpoint, use:\n\n```text\nhttps://management-test.adyen.com/v1/companies/{companyId}/webhooks\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area. Use this API key to make requests to:\n\n```text\nhttps://management-live.adyen.com/v1\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/release-notes/management-api) to find out what changed in this version!",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -3062,7 +3062,7 @@
"Terminal orders - company level"
],
"summary" : "Create an order",
"description" : "Creates an order for payment terminal products for the company identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
"description" : "Creates an order for payment terminal products for the company identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.",
"operationId" : "post-companies-companyId-terminalOrders",
"x-groupName" : "Terminal orders - company level",
"x-sortIndex" : 6,
@@ -5568,6 +5568,91 @@
}
}
},
"/me/generateClientKey" : {
"post" : {
"tags" : [
"My API credential"
],
"summary" : "Generate a client key",
"description" : "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/) used to authenticate requests from your payment environment.\nYou can use the new client key a few minutes after generating it.\nThe old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
"operationId" : "post-me-generateClientKey",
"x-groupName" : "My API credential",
"x-sortIndex" : 0,
"x-methodName" : "generateClientKey",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenerateClientKeyResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/merchants" : {
"get" : {
"tags" : [
@@ -11314,7 +11399,7 @@
"Terminal orders - merchant level"
],
"summary" : "Create an order",
"description" : "Creates an order for payment terminal products for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
"description" : "Creates an order for payment terminal products for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.",
"operationId" : "post-merchants-merchantId-terminalOrders",
"x-groupName" : "Terminal orders - merchant level",
"x-sortIndex" : 6,
@@ -11543,7 +11628,7 @@
"Terminal orders - merchant level"
],
"summary" : "Update an order",
"description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provice the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
"description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
"operationId" : "patch-merchants-merchantId-terminalOrders-orderId",
"x-groupName" : "Terminal orders - merchant level",
"x-sortIndex" : 9,
@@ -16838,37 +16923,8 @@
}
},
"JSONObject" : {
"properties" : {
"paths" : {
"items" : {
"$ref" : "#/components/schemas/JSONPathWrapper"
},
"type" : "array"
},
"rootPath" : {
"$ref" : "#/components/schemas/JSONPath"
}
},
"type" : "object"
},
"JSONPath" : {
"properties" : {
"content" : {
"items" : {
"type" : "string"
},
"type" : "array"
}
},
"type" : "object"
},
"JSONPathWrapper" : {
"properties" : {
"JSONPath" : {
"$ref" : "#/components/schemas/JSONPath"
}
}
},
"Key" : {
"properties" : {
"identifier" : {
@@ -17227,6 +17283,15 @@
],
"type" : "object"
},
"Localization" : {
"properties" : {
"language" : {
"description" : "Language of the terminal.",
"type" : "string"
}
},
"type" : "object"
},
"Logo" : {
"properties" : {
"data" : {
@@ -19460,6 +19525,10 @@
"description" : "Settings for terminal hardware features.",
"$ref" : "#/components/schemas/Hardware"
},
"localization" : {
"description" : "Settings for localization.",
"$ref" : "#/components/schemas/Localization"
},
"nexo" : {
"description" : "Settings for a Terminal API integration.",
"$ref" : "#/components/schemas/Nexo"

41
json/ManagementService-v3.json
View File

@@ -3147,7 +3147,7 @@
"Terminal orders - company level"
],
"summary" : "Create an order",
"description" : "Creates an order for payment terminal products for the company identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
"description" : "Creates an order for payment terminal products for the company identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.",
"operationId" : "post-companies-companyId-terminalOrders",
"x-groupName" : "Terminal orders - company level",
"x-sortIndex" : 6,
@@ -5658,12 +5658,12 @@
"tags" : [
"My API credential"
],
"summary" : "Generate new client key for self",
"description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the caller - API Credential or OAuth Access Token. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
"summary" : "Generate a client key",
"description" : "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/) used to authenticate requests from your payment environment.\nYou can use the new client key a few minutes after generating it.\nThe old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
"operationId" : "post-me-generateClientKey",
"x-groupName" : "My API credential",
"x-sortIndex" : 0,
"x-methodName" : "generateNewClientKeyForSelf",
"x-methodName" : "generateClientKey",
"security" : [
{
"BasicAuth" : [
@@ -11478,7 +11478,7 @@
"Terminal orders - merchant level"
],
"summary" : "Create an order",
"description" : "Creates an order for payment terminal products for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
"description" : "Creates an order for payment terminal products for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.",
"operationId" : "post-merchants-merchantId-terminalOrders",
"x-groupName" : "Terminal orders - merchant level",
"x-sortIndex" : 6,
@@ -11707,7 +11707,7 @@
"Terminal orders - merchant level"
],
"summary" : "Update an order",
"description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provice the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
"description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
"operationId" : "patch-merchants-merchantId-terminalOrders-orderId",
"x-groupName" : "Terminal orders - merchant level",
"x-sortIndex" : 9,
@@ -17096,28 +17096,6 @@
"type" : "object"
},
"JSONObject" : {
"properties" : {
"paths" : {
"items" : {
"$ref" : "#/components/schemas/JSONPath"
},
"type" : "array"
},
"rootPath" : {
"$ref" : "#/components/schemas/JSONPath"
}
},
"type" : "object"
},
"JSONPath" : {
"properties" : {
"content" : {
"items" : {
"type" : "string"
},
"type" : "array"
}
},
"type" : "object"
},
"Key" : {
@@ -19485,11 +19463,12 @@
"$ref" : "#/components/schemas/TerminalReassignmentTarget"
},
"status" : {
"description" : "The status of the reassignment. Possible values: \n * `reassignmentInProgress`: the terminal was boarded and is now scheduled to remove the configuration. Wait for the terminal to synchronize with the Adyen platform.\n * `deployed`: the terminal is deployed and reassigned. \n * `inventory`: the terminal is in inventory and cannot process transactions. \n",
"description" : "The status of the reassignment. Possible values: \n * `reassignmentInProgress`: the terminal was boarded and is now scheduled to remove the configuration. Wait for the terminal to synchronize with the Adyen platform.\n * `deployed`: the terminal is deployed and reassigned. \n * `inventory`: the terminal is in inventory and cannot process transactions. \n * `boarded`: the terminal is boarded to a store, or a merchant account representing a store, and can process transactions. \n",
"enum" : [
"reassignmentInProgress",
"boarded",
"deployed",
"inventory"
"inventory",
"reassignmentInProgress"
],
"type" : "string"
},

104
yaml/ManagementService-v1.yaml
View File

@@ -22,7 +22,7 @@ info:
Management API handles versioning as part of the endpoint URL. For example, to
send a request to version 1 of the `/companies/{companyId}/webhooks` endpoint,
send a request to this version of the `/companies/{companyId}/webhooks` endpoint,
use:
@@ -44,7 +44,13 @@ info:
https://management-live.adyen.com/v1
```'
```
## Release notes
Have a look at the [release notes](https://docs.adyen.com/release-notes/management-api)
to find out what changed in this version!'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -2030,7 +2036,10 @@ paths:
description: "Creates an order for payment terminal products for the company\
\ identified in the path.\n\nTo make this request, your API credential must\
\ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n>Requests to the Management\
\ API test endpoint do not create actual orders for test terminals. To order\
\ test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps)\
\ in your Customer Area."
operationId: post-companies-companyId-terminalOrders
x-groupName: Terminal orders - company level
x-sortIndex: 6
@@ -3654,6 +3663,61 @@ paths:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/me/generateClientKey:
post:
tags:
- My API credential
summary: Generate a client key
description: "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/)\
\ used to authenticate requests from your payment environment.\nYou can use\
\ the new client key a few minutes after generating it.\nThe old client key\
\ stops working 24 hours after generating a new one.\n\nTo make this request,\
\ your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014API credentials read and write"
operationId: post-me-generateClientKey
x-groupName: My API credential
x-sortIndex: 0
x-methodName: generateClientKey
security:
- BasicAuth: []
- ApiKeyAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateClientKeyResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/merchants:
get:
tags:
@@ -7431,7 +7495,10 @@ paths:
description: "Creates an order for payment terminal products for the merchant\
\ account identified in the path.\n\nTo make this request, your API credential\
\ must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n>Requests to the Management\
\ API test endpoint do not create actual orders for test terminals. To order\
\ test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps)\
\ in your Customer Area."
operationId: post-merchants-merchantId-terminalOrders
x-groupName: Terminal orders - merchant level
x-sortIndex: 6
@@ -7577,7 +7644,7 @@ paths:
description: "Updates the terminal products order identified in the path.\n\
Updating is only possible while the order has the status **Placed**.\n\nThe\
\ request body only needs to contain what you want to change. \nHowever, to\
\ update the products in the `items` array, you must provice the entire array.\
\ update the products in the `items` array, you must provide the entire array.\
\ For example, if the array has three items:\n To remove one item, the array\
\ must include the remaining two items. Or to add one item, the array must\
\ include all four items.\n\nTo make this request, your API credential must\
@@ -11554,25 +11621,7 @@ components:
InvalidField:
$ref: '#/components/schemas/InvalidField'
JSONObject:
properties:
paths:
items:
$ref: '#/components/schemas/JSONPathWrapper'
type: array
rootPath:
$ref: '#/components/schemas/JSONPath'
type: object
JSONPath:
properties:
content:
items:
type: string
type: array
type: object
JSONPathWrapper:
properties:
JSONPath:
$ref: '#/components/schemas/JSONPath'
Key:
properties:
identifier:
@@ -11836,6 +11885,12 @@ components:
- itemsTotal
- pagesTotal
type: object
Localization:
properties:
language:
description: Language of the terminal.
type: string
type: object
Logo:
properties:
data:
@@ -13895,6 +13950,9 @@ components:
hardware:
description: Settings for terminal hardware features.
$ref: '#/components/schemas/Hardware'
localization:
description: Settings for localization.
$ref: '#/components/schemas/Localization'
nexo:
description: Settings for a Terminal API integration.
$ref: '#/components/schemas/Nexo'

47
yaml/ManagementService-v3.yaml
View File

@@ -2093,7 +2093,10 @@ paths:
description: "Creates an order for payment terminal products for the company\
\ identified in the path.\n\nTo make this request, your API credential must\
\ have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n>Requests to the Management\
\ API test endpoint do not create actual orders for test terminals. To order\
\ test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps)\
\ in your Customer Area."
operationId: post-companies-companyId-terminalOrders
x-groupName: Terminal orders - company level
x-sortIndex: 6
@@ -3721,17 +3724,17 @@ paths:
post:
tags:
- My API credential
summary: Generate new client key for self
description: "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works)\
\ for the caller - API Credential or OAuth Access Token. You can use the new\
\ client key a few minutes after generating it. The old client key stops working\
\ 24 hours after generating a new one.To make this request, your API credential\
\ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
summary: Generate a client key
description: "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/)\
\ used to authenticate requests from your payment environment.\nYou can use\
\ the new client key a few minutes after generating it.\nThe old client key\
\ stops working 24 hours after generating a new one.\n\nTo make this request,\
\ your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014API credentials read and write"
operationId: post-me-generateClientKey
x-groupName: My API credential
x-sortIndex: 0
x-methodName: generateNewClientKeyForSelf
x-methodName: generateClientKey
security:
- BasicAuth: []
- ApiKeyAuth: []
@@ -7545,7 +7548,10 @@ paths:
description: "Creates an order for payment terminal products for the merchant\
\ account identified in the path.\n\nTo make this request, your API credential\
\ must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Terminal ordering read and write"
* Management API\u2014Terminal ordering read and write\n>Requests to the Management\
\ API test endpoint do not create actual orders for test terminals. To order\
\ test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps)\
\ in your Customer Area."
operationId: post-merchants-merchantId-terminalOrders
x-groupName: Terminal orders - merchant level
x-sortIndex: 6
@@ -7691,7 +7697,7 @@ paths:
description: "Updates the terminal products order identified in the path.\n\
Updating is only possible while the order has the status **Placed**.\n\nThe\
\ request body only needs to contain what you want to change. \nHowever, to\
\ update the products in the `items` array, you must provice the entire array.\
\ update the products in the `items` array, you must provide the entire array.\
\ For example, if the array has three items:\n To remove one item, the array\
\ must include the remaining two items. Or to add one item, the array must\
\ include all four items.\n\nTo make this request, your API credential must\
@@ -11729,20 +11735,6 @@ components:
- message
type: object
JSONObject:
properties:
paths:
items:
$ref: '#/components/schemas/JSONPath'
type: array
rootPath:
$ref: '#/components/schemas/JSONPath'
type: object
JSONPath:
properties:
content:
items:
type: string
type: array
type: object
Key:
properties:
@@ -13898,11 +13890,14 @@ components:
\ the terminal was boarded and is now scheduled to remove the configuration.\
\ Wait for the terminal to synchronize with the Adyen platform.\n * `deployed`:\
\ the terminal is deployed and reassigned. \n * `inventory`: the terminal\
\ is in inventory and cannot process transactions. \n"
\ is in inventory and cannot process transactions. \n * `boarded`: the\
\ terminal is boarded to a store, or a merchant account representing a\
\ store, and can process transactions. \n"
enum:
- reassignmentInProgress
- boarded
- deployed
- inventory
- reassignmentInProgress
type: string
storeId:
description: The unique identifier of the store to which terminal is assigned.