jlengrand/adyen-postman
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-postman.git synced 2026-03-10 08:01:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
adyen-postman/postman/TfmAPIService-v1.json
AdyenAutomationBot 0926fdccdd Update latest definitions files
2024-09-09 14:14:47 +00:00

1047 lines
36 KiB
JSON
Raw Permalink Blame History

{
"info": {
"name": "POS Terminal Management API (v1)",
"description": {
"content": "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 [Classic assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api/classic-assign-terminals-api/).\n\n>We will deprecate POS Terminal Management API on January 1, 2025 and stop support on April 1, 2025. To automate the management of your terminal fleet, use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).\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## Roles and permissions\nTo use the POS Terminal Management API, you need the **POS Terminal Management API role** added to your API credential. Your Adyen contact will set up the roles for you.\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```\nWhen using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`.\nIf you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`.\n## Going live\nTo access the live endpoints, you need an API key from your live Customer Area.\nUse this API key to make requests to:\n\n```text\nhttps://postfmapi-live.adyen.com/postfmapi/terminal/v1\n```\n\n",
"type": "text/markdown"
},
"version": "1",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "General",
"item": [
{
"name": "/assignTerminals",
"description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory.",
"item": [
{
"name": "Assign a terminal to the company inventory",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"terminals\": [\"P400Plus-275479597\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/assignTerminals",
"host": [
"{{baseUrl}}"
],
"path": [
"assignTerminals"
],
"variable": [
],
"query": [
]
},
"description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"results\": {\n \"P400Plus-275479597\": \"RemoveConfigScheduled\"\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"terminals\": [\"P400Plus-275479597\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/assignTerminals",
"host": [
"{{baseUrl}}"
],
"path": [
"assignTerminals"
],
"variable": [
],
"query": [
]
},
"description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory."
}
}
]
},
{
"name": "Assign a terminal to the inventory of a merchant account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantInventory\": true,\n \"terminals\": [\"P400Plus-275479597\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/assignTerminals",
"host": [
"{{baseUrl}}"
],
"path": [
"assignTerminals"
],
"variable": [
],
"query": [
]
},
"description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"results\": {\n \"P400Plus-275479597\": \"RemoveConfigScheduled\"\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantInventory\": true,\n \"terminals\": [\"P400Plus-275479597\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/assignTerminals",
"host": [
"{{baseUrl}}"
],
"path": [
"assignTerminals"
],
"variable": [
],
"query": [
]
},
"description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory."
}
}
]
},
{
"name": "Assign a terminal to a store",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\": \"YOUR_STORE\",\n \"terminals\": [\"P400Plus-275479597\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/assignTerminals",
"host": [
"{{baseUrl}}"
],
"path": [
"assignTerminals"
],
"variable": [
],
"query": [
]
},
"description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"results\": {\n \"P400Plus-275479597\": \"RemoveConfigScheduled\"\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\": \"YOUR_STORE\",\n \"terminals\": [\"P400Plus-275479597\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/assignTerminals",
"host": [
"{{baseUrl}}"
],
"path": [
"assignTerminals"
],
"variable": [
],
"query": [
]
},
"description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory."
}
}
]
}
]
},
{
"name": "/findTerminal",
"description": "Returns the company account, merchant account, or store that a payment terminal is assigned to.",
"item": [
{
"name": "Find where a terminal is assigned to",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"terminal\": \"M400-401972715\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/findTerminal",
"host": [
"{{baseUrl}}"
],
"path": [
"findTerminal"
],
"variable": [
],
"query": [
]
},
"description": "Returns the company account, merchant account, or store that a payment terminal is assigned to."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"companyAccount\": \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"merchantInventory\": false,\n \"store\": \"YOUR_STORE\",\n \"terminal\": \"M400-401972715\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"terminal\": \"M400-401972715\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/findTerminal",
"host": [
"{{baseUrl}}"
],
"path": [
"findTerminal"
],
"variable": [
],
"query": [
]
},
"description": "Returns the company account, merchant account, or store that a payment terminal is assigned to."
}
}
]
}
]
},
{
"name": "/getStoresUnderAccount",
"description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store.",
"item": [
{
"name": "Get all the stores under a company",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getStoresUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getStoresUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"stores\": [{\n \"store\": \"YOUR_STORE\",\n \"description\": \"YOUR_STORE\",\n \"address\": {\n \"city\": \"The City\",\n \"countryCode\": \"NL\",\n \"postalCode\": \"1234\",\n \"streetAddress\": \"The Street\"\n},\n \"status\": \"Active\",\n \"merchantAccountCode\": \"YOUR_MERCHANT_ACCOUNT\"\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getStoresUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getStoresUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store."
}
}
]
},
{
"name": "Get all the stores under a merchant account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getStoresUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getStoresUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"stores\": [{\n \"store\": \"YOUR_STORE\",\n \"description\": \"YOUR_STORE\",\n \"address\": {\n \"city\": \"The City\",\n \"countryCode\": \"NL\",\n \"postalCode\": \"1234\",\n \"streetAddress\": \"The Street\"\n},\n \"status\": \"Active\",\n \"merchantAccountCode\": \"YOUR_MERCHANT_ACCOUNT\"\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getStoresUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getStoresUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store."
}
}
]
}
]
},
{
"name": "/getTerminalDetails",
"description": "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report.",
"item": [
{
"name": "Get information about a specific terminal",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"terminal\": \"M400-401972715\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getTerminalDetails",
"host": [
"{{baseUrl}}"
],
"path": [
"getTerminalDetails"
],
"variable": [
],
"query": [
]
},
"description": "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"companyAccount\": \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"merchantInventory\": false,\n \"store\": \"YOUR_STORE\",\n \"terminal\": \"M400-401972715\",\n \"deviceModel\": \"M400\",\n \"serialNumber\": \"401-972-715\",\n \"permanentTerminalId\": \"88912016\",\n \"terminalStatus\": \"SwitchedOff\",\n \"firmwareVersion\": \"Verifone_VOS 1.57.6\",\n \"country\": \"NETHERLANDS\",\n \"storeDetails\": {\n \"store\": \"YOUR_STORE\",\n \"description\": \"TestStore\",\n \"address\": {\n \"city\": \"The City\",\n \"countryCode\": \"NL\",\n \"postalCode\": \"1234\",\n \"streetAddress\": \"The Street\"\n}\n},\n \"ethernetMac\": \"60:c7:98:5a:69:cd\",\n \"ethernetIp\": \"192.168.2.11\",\n \"wifiMac\": \"c4:ac:59:47:f3:71\",\n \"wifiIp\": \"192.168.2.12\",\n \"dhcpEnabled\": false\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"terminal\": \"M400-401972715\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getTerminalDetails",
"host": [
"{{baseUrl}}"
],
"path": [
"getTerminalDetails"
],
"variable": [
],
"query": [
]
},
"description": "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report."
}
}
]
}
]
},
{
"name": "/getTerminalsUnderAccount",
"description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded).",
"item": [
{
"name": "Get all the terminals under a company account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getTerminalsUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getTerminalsUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"companyAccount\": \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccounts\": [{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"inStoreTerminals\": [\"P400Plus-275479597\"],\n \"stores\": [{\n \"store\": \"YOUR_STORE\",\n \"inStoreTerminals\": [\"M400-401972715\"]\n}]\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getTerminalsUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getTerminalsUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)."
}
}
]
},
{
"name": "Get all the terminals under a merchant account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getTerminalsUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getTerminalsUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"companyAccount\": \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccounts\": [{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"inStoreTerminals\": [\"P400Plus-275479597\"],\n \"stores\": [{\n \"store\": \"YOUR_STORE\",\n \"inStoreTerminals\": [\"M400-401972715\"]\n}]\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getTerminalsUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getTerminalsUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)."
}
}
]
},
{
"name": "Get all the terminals assigned to a store",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\": \"YOUR_STORE\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getTerminalsUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getTerminalsUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"companyAccount\": \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccounts\": [{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"stores\": [{\n \"store\": \"YOUR_STORE\",\n \"inStoreTerminals\": [\"M400-401972715\"]\n}]\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\": \"YOUR_STORE\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/getTerminalsUnderAccount",
"host": [
"{{baseUrl}}"
],
"path": [
"getTerminalsUnderAccount"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)."
}
}
]
}
]
}
]
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{X-API-Key}}",
"type": "string"
},
{
"key": "key",
"value": "X-API-Key",
"type": "string"
}
]
},
"variable": [
{
"key": "baseUrl",
"value": "https://postfmapi-test.adyen.com/postfmapi/terminal/v1",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
},
{
"key": "YOUR_COMPANY_ACCOUNT",
"value": "",
"type": "string"
},
{
"key": "YOUR_MERCHANT_ACCOUNT",
"value": "",
"type": "string"
}
]
}
Reference in New Issue View Git Blame Copy Permalink