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
2022-08-22 13:31:11 +00:00
parent 669c8501a1
commit 93ed04bfd4
2 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
json/TfmAPIService-v1.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "POS Terminal Management API",
"description" : "This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store.\n\nFor more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api).\n\n## Authentication\nEach request to the Terminal Management 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/development-resources/api-credentials#generate-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_API_key\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nTerminal Management 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://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount\n```",
"x-timestamp" : "2022-05-03T09:24:09Z",
"x-timestamp" : "2022-08-15T11:22:35Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -1026,30 +1026,30 @@
"Store" : {
"properties" : {
"address" : {
"description" : "The store address",
"description" : "The address of the store.",
"$ref" : "#/components/schemas/Address"
},
"description" : {
"description" : "The store description",
"description" : "The description of the store.",
"type" : "string"
},
"inStoreTerminals" : {
"description" : "List of unique terminal IDs assigned to this store",
"description" : "The list of terminals assigned to the store.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"merchantAccountCode" : {
"description" : "Merchant account code",
"description" : "The code of the merchant account.",
"type" : "string"
},
"status" : {
"description" : "Store status. Possible values: \n\n- `PreActive`: The store has been created, but not yet activated. \n\n- `Active`: The store has been activated. This means you can process payments over the store. \n\n- `Inactive`: The store is currently not active. \n\n- `InactiveWithModifications`: The store is currently not active, but payment modifications such as refunds are still allowed. \n\n- `Closed`: The store has been closed. ",
"description" : "The status of the store:\n\n- `PreActive`: the store has been created, but not yet activated. \n\n- `Active`: the store has been activated. This means you can process payments for this store. \n\n- `Inactive`: the store is currently not active. \n\n- `InactiveWithModifications`: the store is currently not active, but payment modifications such as refunds are possible. \n\n- `Closed`: the store has been closed. ",
"type" : "string"
},
"store" : {
"description" : "The store code of the store.",
"description" : "The code of the store.",
"type" : "string"
}
},

24
yaml/TfmAPIService-v1.yaml
View File

@@ -52,7 +52,7 @@ info:
https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount
```'
x-timestamp: '2022-05-03T09:24:09Z'
x-timestamp: '2022-08-15T11:22:35Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -796,29 +796,29 @@ components:
Store:
properties:
address:
description: The store address
description: The address of the store.
$ref: '#/components/schemas/Address'
description:
description: The store description
description: The description of the store.
type: string
inStoreTerminals:
description: List of unique terminal IDs assigned to this store
description: The list of terminals assigned to the store.
items:
type: string
type: array
merchantAccountCode:
description: Merchant account code
description: The code of the merchant account.
type: string
status:
description: "Store status. Possible values: \n\n- `PreActive`: The store\
\ has been created, but not yet activated. \n\n- `Active`: The store has\
\ been activated. This means you can process payments over the store.\
\ \n\n- `Inactive`: The store is currently not active. \n\n- `InactiveWithModifications`:\
\ The store is currently not active, but payment modifications such as\
\ refunds are still allowed. \n\n- `Closed`: The store has been closed. "
description: "The status of the store:\n\n- `PreActive`: the store has been\
\ created, but not yet activated. \n\n- `Active`: the store has been activated.\
\ This means you can process payments for this store. \n\n- `Inactive`:\
\ the store is currently not active. \n\n- `InactiveWithModifications`:\
\ the store is currently not active, but payment modifications such as\
\ refunds are possible. \n\n- `Closed`: the store has been closed. "
type: string
store:
description: The store code of the store.
description: The code of the store.
type: string
required:
- store