diff --git a/postman/BalanceControlService-v1.json b/postman/BalanceControlService-v1.json index 5eff389..db2c3cc 100644 --- a/postman/BalanceControlService-v1.json +++ b/postman/BalanceControlService-v1.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -59,6 +61,7 @@ } ] } + ] } ], diff --git a/postman/BalancePlatformService-v1.json b/postman/BalancePlatformService-v1.json index 8a457a4..8ea2aa8 100644 --- a/postman/BalancePlatformService-v1.json +++ b/postman/BalancePlatformService-v1.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -65,11 +67,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -106,11 +110,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -147,11 +153,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -181,7 +189,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id", "description": "Returns a legal entity.", @@ -194,6 +203,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -229,7 +239,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id", "description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.", @@ -242,11 +253,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -289,11 +302,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -330,6 +345,7 @@ } ] } + ] }, { @@ -347,6 +363,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -382,7 +399,8 @@ } } ] - }, + } +, { "name": "/balancePlatforms/:id/accountHolders", "description": "Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`.", @@ -395,6 +413,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -427,11 +446,15 @@ "query": [ { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -440,6 +463,7 @@ } ] } + ] }, { @@ -457,11 +481,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -491,7 +517,8 @@ } } ] - }, + } +, { "name": "/paymentInstrumentGroups/:id", "description": "Returns the details of a payment instrument group.", @@ -504,6 +531,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -539,7 +567,8 @@ } } ] - }, + } +, { "name": "/paymentInstrumentGroups/:id/transactionRules", "description": "Returns a list of all the transaction rules associated with a payment instrument group.", @@ -552,6 +581,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -589,6 +619,7 @@ } ] } + ] }, { @@ -606,11 +637,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -640,7 +673,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Deletes a document.", @@ -653,6 +687,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -688,7 +723,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Returns a document.", @@ -701,6 +737,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -736,7 +773,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Updates a document.", @@ -749,11 +787,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -790,6 +830,7 @@ } ] } + ] }, { @@ -807,11 +848,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -841,7 +884,8 @@ } } ] - }, + } +, { "name": "/accountHolders/:id", "description": "Returns an account holder.", @@ -854,6 +898,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -889,7 +934,8 @@ } } ] - }, + } +, { "name": "/accountHolders/:id", "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.", @@ -902,11 +948,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -949,11 +997,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -989,7 +1039,8 @@ } } ] - }, + } +, { "name": "/accountHolders/:id/balanceAccounts", "description": "Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.", @@ -1002,6 +1053,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1034,11 +1086,15 @@ "query": [ { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -1047,6 +1103,7 @@ } ] } + ] }, { @@ -1064,11 +1121,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1105,11 +1164,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1146,11 +1207,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1187,11 +1250,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1221,7 +1286,8 @@ } } ] - }, + } +, { "name": "/paymentInstruments/:id", "description": "Returns the details of a payment instrument.", @@ -1234,6 +1300,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1269,7 +1336,8 @@ } } ] - }, + } +, { "name": "/paymentInstruments/:id", "description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card.", @@ -1282,11 +1350,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1329,11 +1399,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1369,7 +1441,8 @@ } } ] - }, + } +, { "name": "/paymentInstruments/:id/reveal", "description": "Returns the primary account number (PAN) of a payment instrument. To make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions): * Balance Platform BCL PCI role", @@ -1382,6 +1455,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1418,7 +1492,8 @@ } } ] - }, + } +, { "name": "/paymentInstruments/:id/transactionRules", "description": "Returns a list of transaction rules associated with a payment instrument.", @@ -1431,6 +1506,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1468,6 +1544,7 @@ } ] } + ] }, { @@ -1485,11 +1562,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1526,11 +1605,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1561,6 +1642,7 @@ } ] } + ] }, { @@ -1578,11 +1660,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1619,11 +1703,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1653,7 +1739,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Deletes a transfer instrument.", @@ -1666,6 +1753,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1701,7 +1789,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Returns the details of a transfer instrument.", @@ -1714,6 +1803,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1749,7 +1839,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Updates a transfer instrument.", @@ -1762,11 +1853,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1803,6 +1896,7 @@ } ] } + ] }, { @@ -1820,11 +1914,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1854,7 +1950,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:id", "description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.", @@ -1867,6 +1964,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1902,7 +2000,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:id", "description": "Updates a balance account.", @@ -1915,11 +2014,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1955,7 +2056,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:id/paymentInstruments", "description": "Returns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`.", @@ -1968,6 +2070,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2000,11 +2103,15 @@ "query": [ { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -2013,6 +2120,7 @@ } ] } + ] }, { @@ -2030,11 +2138,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2064,7 +2174,8 @@ } } ] - }, + } +, { "name": "/transactionRules/:transactionRuleId", "description": "Deletes a transaction rule.", @@ -2077,6 +2188,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2112,7 +2224,8 @@ } } ] - }, + } +, { "name": "/transactionRules/:transactionRuleId", "description": "Returns the details of a transaction rule.", @@ -2125,6 +2238,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2160,7 +2274,8 @@ } } ] - }, + } +, { "name": "/transactionRules/:transactionRuleId", "description": "Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged. * When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource.", @@ -2173,11 +2288,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2214,6 +2331,7 @@ } ] } + ] } ], diff --git a/postman/BalancePlatformService-v2.json b/postman/BalancePlatformService-v2.json index a9c4fa7..296fe64 100644 --- a/postman/BalancePlatformService-v2.json +++ b/postman/BalancePlatformService-v2.json @@ -24,6 +24,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -59,7 +60,8 @@ } } ] - }, + } +, { "name": "/balancePlatforms/:id/accountHolders", "description": "Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`.", @@ -72,6 +74,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -104,11 +107,15 @@ "query": [ { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -117,6 +124,7 @@ } ] } + ] }, { @@ -134,6 +142,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -159,7 +168,9 @@ "query": [ { "key": "accountHolderId", - "value": "accountHolderId_example" + "value": "accountHolderId_example", + "description": "The unique identifier of the grant account.", + "disabled": false } ] }, @@ -167,7 +178,8 @@ } } ] - }, + } +, { "name": "/grantOffers/:grantOfferId", "description": "Returns the details of a single grant offer.", @@ -180,6 +192,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -216,6 +229,7 @@ } ] } + ] }, { @@ -233,11 +247,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -267,7 +283,8 @@ } } ] - }, + } +, { "name": "/paymentInstrumentGroups/:id", "description": "Returns the details of a payment instrument group.", @@ -280,6 +297,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -315,7 +333,8 @@ } } ] - }, + } +, { "name": "/paymentInstrumentGroups/:id/transactionRules", "description": "Returns a list of all the transaction rules associated with a payment instrument group.", @@ -328,6 +347,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -365,6 +385,7 @@ } ] } + ] }, { @@ -382,6 +403,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -417,7 +439,8 @@ } } ] - }, + } +, { "name": "/networkTokens/:networkTokenId", "description": "Updates the status of the network token.", @@ -430,11 +453,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -471,6 +496,7 @@ } ] } + ] }, { @@ -488,11 +514,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -522,7 +550,8 @@ } } ] - }, + } +, { "name": "/accountHolders/:id", "description": "Returns an account holder.", @@ -535,6 +564,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -570,7 +600,8 @@ } } ] - }, + } +, { "name": "/accountHolders/:id", "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.", @@ -583,11 +614,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -630,11 +663,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -670,7 +705,8 @@ } } ] - }, + } +, { "name": "/accountHolders/:id/balanceAccounts", "description": "Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.", @@ -683,6 +719,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -715,11 +752,15 @@ "query": [ { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -727,7 +768,8 @@ } } ] - }, + } +, { "name": "/accountHolders/:id/taxForms", "description": "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/us-tax-forms/).", @@ -740,6 +782,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -772,11 +815,15 @@ "query": [ { "key": "formType", - "value": "formType_example" + "value": "formType_example", + "description": "The type of tax form you want to retrieve. Accepted values are **US1099k** and **US1099nec**", + "disabled": false }, { "key": "year", - "value": "56" + "value": "56", + "description": "The tax year in YYYY format for the tax form you want to retrieve", + "disabled": false } ] }, @@ -785,6 +832,7 @@ } ] } + ] }, { @@ -802,11 +850,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -843,11 +893,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -884,11 +936,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -925,11 +979,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -959,7 +1015,8 @@ } } ] - }, + } +, { "name": "/paymentInstruments/:id", "description": "Returns the details of a payment instrument.", @@ -972,6 +1029,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1007,7 +1065,8 @@ } } ] - }, + } +, { "name": "/paymentInstruments/:id", "description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card.", @@ -1020,11 +1079,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1067,11 +1128,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1107,7 +1170,8 @@ } } ] - }, + } +, { "name": "/paymentInstruments/:id/networkTokens", "description": "List the network tokens connected to a payment instrument.", @@ -1120,6 +1184,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1156,7 +1221,8 @@ } } ] - }, + } +, { "name": "/paymentInstruments/:id/reveal", "description": "Returns the primary account number (PAN) of a payment instrument. To make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions): * Balance Platform BCL PCI role", @@ -1169,6 +1235,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1205,7 +1272,8 @@ } } ] - }, + } +, { "name": "/paymentInstruments/:id/transactionRules", "description": "Returns a list of transaction rules associated with a payment instrument.", @@ -1218,6 +1286,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1255,6 +1324,7 @@ } ] } + ] }, { @@ -1272,11 +1342,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1313,11 +1385,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1348,6 +1422,7 @@ } ] } + ] }, { @@ -1365,6 +1440,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1401,6 +1477,7 @@ } ] } + ] }, { @@ -1418,11 +1495,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1452,7 +1531,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:balanceAccountId/sweeps", "description": "Returns a list of the sweeps configured for a balance account. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use `/balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10`.", @@ -1465,6 +1545,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1497,11 +1578,15 @@ "query": [ { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -1509,7 +1594,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:balanceAccountId/sweeps", "description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.", @@ -1522,11 +1608,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1570,11 +1658,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1618,11 +1708,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1659,7 +1751,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:balanceAccountId/sweeps/:sweepId", "description": "Deletes a sweep for a balance account.", @@ -1672,6 +1765,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1714,7 +1808,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:balanceAccountId/sweeps/:sweepId", "description": "Returns a sweep.", @@ -1727,6 +1822,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1769,7 +1865,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:balanceAccountId/sweeps/:sweepId", "description": "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged.", @@ -1782,11 +1879,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1829,7 +1928,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:id", "description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.", @@ -1842,6 +1942,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1877,7 +1978,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:id", "description": "Updates a balance account.", @@ -1890,11 +1992,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1930,7 +2034,8 @@ } } ] - }, + } +, { "name": "/balanceAccounts/:id/paymentInstruments", "description": "Returns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`.", @@ -1943,6 +2048,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1975,11 +2081,15 @@ "query": [ { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -1988,6 +2098,7 @@ } ] } + ] }, { @@ -2005,11 +2116,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2046,11 +2159,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2087,11 +2202,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2128,11 +2245,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2162,7 +2281,8 @@ } } ] - }, + } +, { "name": "/transactionRules/:transactionRuleId", "description": "Deletes a transaction rule.", @@ -2175,6 +2295,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2210,7 +2331,8 @@ } } ] - }, + } +, { "name": "/transactionRules/:transactionRuleId", "description": "Returns the details of a transaction rule.", @@ -2223,6 +2345,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2258,7 +2381,8 @@ } } ] - }, + } +, { "name": "/transactionRules/:transactionRuleId", "description": "Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged. * When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource.", @@ -2271,11 +2395,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2312,6 +2438,7 @@ } ] } + ] }, { @@ -2329,11 +2456,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2365,6 +2494,7 @@ } ] } + ] } ], diff --git a/postman/BinLookupService-v40.json b/postman/BinLookupService-v40.json index 61507ab..a3b65f7 100644 --- a/postman/BinLookupService-v40.json +++ b/postman/BinLookupService-v40.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/getCostEstimate", "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -270,6 +283,7 @@ } ] } + ] } ], diff --git a/postman/BinLookupService-v50.json b/postman/BinLookupService-v50.json index 3bd8a32..92c1fb4 100644 --- a/postman/BinLookupService-v50.json +++ b/postman/BinLookupService-v50.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/getCostEstimate", "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -270,6 +283,7 @@ } ] } + ] } ], diff --git a/postman/BinLookupService-v52.json b/postman/BinLookupService-v52.json index fa2a4d1..fd8110d 100644 --- a/postman/BinLookupService-v52.json +++ b/postman/BinLookupService-v52.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/getCostEstimate", "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -270,6 +283,7 @@ } ] } + ] } ], diff --git a/postman/BinLookupService-v53.json b/postman/BinLookupService-v53.json index 8dbfd39..e109ddc 100644 --- a/postman/BinLookupService-v53.json +++ b/postman/BinLookupService-v53.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/getCostEstimate", "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -270,6 +283,7 @@ } ] } + ] } ], diff --git a/postman/BinLookupService-v54.json b/postman/BinLookupService-v54.json index 0756281..1990a39 100644 --- a/postman/BinLookupService-v54.json +++ b/postman/BinLookupService-v54.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/getCostEstimate", "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -270,6 +283,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v37.json b/postman/CheckoutService-v37.json index e802c03..d66d59e 100644 --- a/postman/CheckoutService-v37.json +++ b/postman/CheckoutService-v37.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -553,7 +589,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -566,16 +603,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -607,6 +647,7 @@ } ] } + ] }, { @@ -624,16 +665,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -663,7 +707,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -676,16 +721,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -716,7 +764,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -729,16 +778,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -776,16 +828,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -817,6 +872,7 @@ } ] } + ] }, { @@ -834,16 +890,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -874,7 +933,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -887,16 +947,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -927,6 +990,7 @@ } ] } + ] }, { @@ -944,16 +1008,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1029,7 +1099,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1042,16 +1113,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1127,7 +1204,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1140,16 +1218,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1271,7 +1358,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1284,16 +1372,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1691,7 +1806,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -1704,16 +1820,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1751,16 +1870,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1792,6 +1914,7 @@ } ] } + ] }, { @@ -1809,16 +1932,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1848,7 +1974,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -1861,6 +1988,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1896,7 +2024,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -1909,11 +2038,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1950,6 +2081,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v40.json b/postman/CheckoutService-v40.json index 3ce2c86..1adde7a 100644 --- a/postman/CheckoutService-v40.json +++ b/postman/CheckoutService-v40.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2059,7 +2198,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2072,16 +2212,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2119,16 +2262,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2160,6 +2306,7 @@ } ] } + ] }, { @@ -2177,16 +2324,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2216,7 +2366,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2229,6 +2380,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2264,7 +2416,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2277,11 +2430,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2318,6 +2473,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v41.json b/postman/CheckoutService-v41.json index 3eb86c2..bdba246 100644 --- a/postman/CheckoutService-v41.json +++ b/postman/CheckoutService-v41.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2151,7 +2296,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2164,16 +2310,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2211,16 +2360,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2258,16 +2410,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2305,16 +2460,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2346,6 +2504,7 @@ } ] } + ] }, { @@ -2363,16 +2522,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2402,7 +2564,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2415,6 +2578,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2450,7 +2614,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2463,11 +2628,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2504,6 +2671,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v46.json b/postman/CheckoutService-v46.json index b5edaf2..f61f35a 100644 --- a/postman/CheckoutService-v46.json +++ b/postman/CheckoutService-v46.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2151,7 +2296,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2164,16 +2310,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2211,16 +2360,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2258,16 +2410,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2305,16 +2460,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2346,6 +2504,7 @@ } ] } + ] }, { @@ -2363,16 +2522,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2402,7 +2564,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2415,6 +2578,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2450,7 +2614,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2463,11 +2628,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2504,6 +2671,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v49.json b/postman/CheckoutService-v49.json index 40c09ed..e322377 100644 --- a/postman/CheckoutService-v49.json +++ b/postman/CheckoutService-v49.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2151,7 +2296,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2164,16 +2310,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2211,16 +2360,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2258,16 +2410,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2305,16 +2460,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2346,6 +2504,7 @@ } ] } + ] }, { @@ -2363,16 +2522,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2402,7 +2564,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2415,6 +2578,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2450,7 +2614,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2463,11 +2628,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2504,6 +2671,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v50.json b/postman/CheckoutService-v50.json index 7b927dc..4bcbcab 100644 --- a/postman/CheckoutService-v50.json +++ b/postman/CheckoutService-v50.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2158,16 +2303,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2197,7 +2345,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2210,16 +2359,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2257,16 +2409,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2304,16 +2459,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2351,16 +2509,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2392,6 +2553,7 @@ } ] } + ] }, { @@ -2409,16 +2571,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2448,7 +2613,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2461,6 +2627,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2496,7 +2663,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2509,11 +2677,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2550,6 +2720,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v51.json b/postman/CheckoutService-v51.json index 417d03e..e179036 100644 --- a/postman/CheckoutService-v51.json +++ b/postman/CheckoutService-v51.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2158,16 +2303,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2197,7 +2345,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2210,16 +2359,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2257,16 +2409,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2304,16 +2459,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2351,16 +2509,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2392,6 +2553,7 @@ } ] } + ] }, { @@ -2409,16 +2571,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2448,7 +2613,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2461,6 +2627,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2496,7 +2663,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2509,11 +2677,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2550,6 +2720,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v52.json b/postman/CheckoutService-v52.json index 3316fe3..a276c1a 100644 --- a/postman/CheckoutService-v52.json +++ b/postman/CheckoutService-v52.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2158,16 +2303,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2197,7 +2345,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2210,16 +2359,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2257,16 +2409,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2304,16 +2459,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2351,16 +2509,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2392,6 +2553,7 @@ } ] } + ] }, { @@ -2409,16 +2571,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2448,7 +2613,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2461,6 +2627,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2496,7 +2663,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2509,11 +2677,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2550,6 +2720,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v53.json b/postman/CheckoutService-v53.json index 5d32580..71e1f41 100644 --- a/postman/CheckoutService-v53.json +++ b/postman/CheckoutService-v53.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2158,16 +2303,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2197,7 +2345,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2210,16 +2359,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2257,16 +2409,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2304,16 +2459,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2351,16 +2509,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2392,6 +2553,7 @@ } ] } + ] }, { @@ -2409,16 +2571,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2448,7 +2613,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2461,6 +2627,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2496,7 +2663,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2509,11 +2677,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2550,6 +2720,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v64.json b/postman/CheckoutService-v64.json index e788a6b..88282c8 100644 --- a/postman/CheckoutService-v64.json +++ b/postman/CheckoutService-v64.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2158,16 +2303,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2197,7 +2345,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2210,16 +2359,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2257,16 +2409,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2304,16 +2459,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2351,16 +2509,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2392,6 +2553,7 @@ } ] } + ] }, { @@ -2409,16 +2571,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2448,7 +2613,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2461,6 +2627,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2496,7 +2663,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2509,11 +2677,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2550,6 +2720,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v65.json b/postman/CheckoutService-v65.json index b5aa35d..a78a2a4 100644 --- a/postman/CheckoutService-v65.json +++ b/postman/CheckoutService-v65.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2158,16 +2303,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2197,7 +2345,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2210,16 +2359,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2257,16 +2409,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2304,16 +2459,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2351,16 +2509,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2392,6 +2553,7 @@ } ] } + ] }, { @@ -2409,16 +2571,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2448,7 +2613,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2461,6 +2627,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2496,7 +2663,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2509,11 +2677,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2550,6 +2720,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v66.json b/postman/CheckoutService-v66.json index efc1084..1f1a46b 100644 --- a/postman/CheckoutService-v66.json +++ b/postman/CheckoutService-v66.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2158,16 +2303,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2197,7 +2345,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2210,16 +2359,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2257,16 +2409,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2304,16 +2459,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2351,16 +2509,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2392,6 +2553,7 @@ } ] } + ] }, { @@ -2409,16 +2571,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2448,7 +2613,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2461,6 +2627,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2496,7 +2663,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2509,11 +2677,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2550,6 +2720,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v67.json b/postman/CheckoutService-v67.json index cbc6959..d516f54 100644 --- a/postman/CheckoutService-v67.json +++ b/postman/CheckoutService-v67.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys (DEPRECATED)", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2151,7 +2296,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2164,16 +2310,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2211,16 +2360,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2252,6 +2404,7 @@ } ] } + ] }, { @@ -2269,16 +2422,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2308,7 +2464,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2321,6 +2478,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2356,7 +2514,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2369,11 +2528,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2410,6 +2571,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v68.json b/postman/CheckoutService-v68.json index 7cbe935..e1698ac 100644 --- a/postman/CheckoutService-v68.json +++ b/postman/CheckoutService-v68.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys (DEPRECATED)", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2151,7 +2296,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2164,16 +2310,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2211,16 +2360,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2251,7 +2403,8 @@ } } ] - }, + } +, { "name": "/sessions", "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook.", @@ -2264,16 +2417,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2310,16 +2466,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2356,16 +2515,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2402,16 +2564,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2441,7 +2606,8 @@ } } ] - }, + } +, { "name": "/sessions/:sessionId", "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.", @@ -2454,6 +2620,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2485,7 +2652,9 @@ "query": [ { "key": "sessionResult", - "value": "sessionResult_example" + "value": "sessionResult_example", + "description": "The `sessionResult` value from the Drop-in or Component.", + "disabled": false } ] }, @@ -2494,6 +2663,7 @@ } ] } + ] }, { @@ -2511,16 +2681,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2550,7 +2723,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2563,6 +2737,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2598,7 +2773,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2611,11 +2787,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2652,6 +2830,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v69.json b/postman/CheckoutService-v69.json index 025c6aa..31f6eff 100644 --- a/postman/CheckoutService-v69.json +++ b/postman/CheckoutService-v69.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys (DEPRECATED)", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,16 +1057,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1036,16 +1106,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1075,7 +1148,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1088,16 +1162,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1134,16 +1211,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1173,7 +1253,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1186,16 +1267,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1232,16 +1316,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1278,16 +1365,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1317,7 +1407,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1330,16 +1421,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1376,16 +1470,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1422,16 +1519,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1468,16 +1568,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1514,16 +1617,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1560,16 +1666,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1606,16 +1715,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1652,16 +1764,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1698,16 +1813,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1744,16 +1862,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1790,16 +1911,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1836,16 +1960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1882,16 +2009,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1928,16 +2058,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1974,16 +2107,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2020,16 +2156,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2066,16 +2205,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2112,16 +2254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2151,7 +2296,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2164,16 +2310,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2211,16 +2360,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2251,7 +2403,8 @@ } } ] - }, + } +, { "name": "/sessions", "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook.", @@ -2264,16 +2417,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2310,16 +2466,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2356,16 +2515,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2402,16 +2564,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2441,7 +2606,8 @@ } } ] - }, + } +, { "name": "/sessions/:sessionId", "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.", @@ -2454,6 +2620,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2485,7 +2652,9 @@ "query": [ { "key": "sessionResult", - "value": "sessionResult_example" + "value": "sessionResult_example", + "description": "The `sessionResult` value from the Drop-in or Component.", + "disabled": false } ] }, @@ -2494,6 +2663,7 @@ } ] } + ] }, { @@ -2511,16 +2681,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2550,7 +2723,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2563,6 +2737,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2598,7 +2773,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2611,11 +2787,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2652,6 +2830,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v70.json b/postman/CheckoutService-v70.json index f289f7a..55175b6 100644 --- a/postman/CheckoutService-v70.json +++ b/postman/CheckoutService-v70.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -63,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -76,16 +80,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -112,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -135,16 +143,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -171,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -181,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -194,16 +206,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -230,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -240,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -253,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -289,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -299,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -312,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -348,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -359,6 +382,7 @@ } ] } + ] }, { @@ -376,16 +400,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -422,16 +449,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -468,16 +498,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -514,16 +547,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -560,16 +596,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -599,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -612,16 +652,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -653,6 +696,7 @@ } ] } + ] }, { @@ -670,16 +714,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -709,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -722,16 +770,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -762,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -775,16 +827,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -822,16 +877,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -863,6 +921,7 @@ } ] } + ] }, { @@ -880,16 +939,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -920,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys (DEPRECATED)", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -933,16 +996,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -973,6 +1039,7 @@ } ] } + ] }, { @@ -990,6 +1057,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1015,11 +1083,15 @@ "query": [ { "key": "shopperReference", - "value": "shopperReference_example" + "value": "shopperReference_example", + "description": "Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.", + "disabled": true }, { "key": "merchantAccount", - "value": "merchantAccount_example" + "value": "merchantAccount_example", + "description": "Your merchant account.", + "disabled": true } ] }, @@ -1027,7 +1099,8 @@ } } ] - }, + } +, { "name": "/storedPaymentMethods/:storedPaymentMethodId", "description": "Deletes the token identified in the path. The token can no longer be used with payment requests.", @@ -1066,11 +1139,15 @@ "query": [ { "key": "shopperReference", - "value": "shopperReference_example" + "value": "shopperReference_example", + "description": "Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.", + "disabled": false }, { "key": "merchantAccount", - "value": "merchantAccount_example" + "value": "merchantAccount_example", + "description": "Your merchant account.", + "disabled": false } ] }, @@ -1079,6 +1156,7 @@ } ] } + ] }, { @@ -1096,16 +1174,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1142,16 +1223,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1181,7 +1265,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1194,16 +1279,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1240,16 +1328,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1279,7 +1370,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1292,16 +1384,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1338,16 +1433,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1384,16 +1482,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1423,7 +1524,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -1436,16 +1538,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1482,16 +1587,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1528,16 +1636,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1574,16 +1685,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1620,16 +1734,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1666,16 +1783,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1712,16 +1832,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1758,16 +1881,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1804,16 +1930,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1850,16 +1979,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1896,16 +2028,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1942,16 +2077,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -1988,16 +2126,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2034,16 +2175,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2080,16 +2224,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2126,16 +2273,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2172,16 +2322,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2218,16 +2371,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2257,7 +2413,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2270,16 +2427,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2317,16 +2477,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2357,7 +2520,8 @@ } } ] - }, + } +, { "name": "/sessions", "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook.", @@ -2370,16 +2534,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2416,16 +2583,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2462,16 +2632,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2508,16 +2681,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2547,7 +2723,8 @@ } } ] - }, + } +, { "name": "/sessions/:sessionId", "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.", @@ -2560,6 +2737,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2591,7 +2769,9 @@ "query": [ { "key": "sessionResult", - "value": "sessionResult_example" + "value": "sessionResult_example", + "description": "The `sessionResult` value from the Drop-in or Component.", + "disabled": false } ] }, @@ -2600,6 +2780,7 @@ } ] } + ] }, { @@ -2617,16 +2798,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "Idempotency-Key", "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "disabled": true } ], @@ -2656,7 +2840,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2669,6 +2854,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2704,7 +2890,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2717,11 +2904,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2758,6 +2947,7 @@ } ] } + ] } ], diff --git a/postman/CheckoutService-v71.json b/postman/CheckoutService-v71.json index 790e2f7..9343677 100644 --- a/postman/CheckoutService-v71.json +++ b/postman/CheckoutService-v71.json @@ -66,7 +66,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/amountUpdates", "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", @@ -118,7 +119,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." } ], "query": [ @@ -128,7 +129,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/cancels", "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", @@ -180,7 +182,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. " } ], "query": [ @@ -190,7 +192,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/captures", "description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", @@ -242,7 +245,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture." } ], "query": [ @@ -252,7 +255,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/refunds", "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", @@ -304,7 +308,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund." } ], "query": [ @@ -314,7 +318,8 @@ } } ] - }, + } +, { "name": "/payments/:paymentPspReference/reversals", "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", @@ -366,7 +371,7 @@ { "key": "paymentPspReference", "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. " } ], "query": [ @@ -377,6 +382,7 @@ } ] } + ] }, { @@ -632,7 +638,8 @@ } } ] - }, + } +, { "name": "/payments/result (DEPRECATED)", "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/online-payments#howitworks).", @@ -689,6 +696,7 @@ } ] } + ] }, { @@ -748,7 +756,8 @@ } } ] - }, + } +, { "name": "/orders/cancel", "description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", @@ -804,7 +813,8 @@ } } ] - }, + } +, { "name": "/paymentMethods/balance", "description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", @@ -911,6 +921,7 @@ } ] } + ] }, { @@ -971,7 +982,8 @@ } } ] - }, + } +, { "name": "/originKeys (DEPRECATED)", "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", @@ -1027,6 +1039,7 @@ } ] } + ] }, { @@ -1086,7 +1099,8 @@ } } ] - }, + } +, { "name": "/storedPaymentMethods/:storedPaymentMethodId", "description": "Deletes the token identified in the path. The token can no longer be used with payment requests.", @@ -1142,6 +1156,7 @@ } ] } + ] }, { @@ -1250,7 +1265,8 @@ } } ] - }, + } +, { "name": "/donations", "description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).", @@ -1354,7 +1370,8 @@ } } ] - }, + } +, { "name": "/paymentMethods", "description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", @@ -1507,7 +1524,8 @@ } } ] - }, + } +, { "name": "/payments", "description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ", @@ -2395,7 +2413,8 @@ } } ] - }, + } +, { "name": "/payments/details", "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 when the shopper was redirected to another page to complete the payment. ", @@ -2501,7 +2520,8 @@ } } ] - }, + } +, { "name": "/sessions", "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook.", @@ -2703,7 +2723,8 @@ } } ] - }, + } +, { "name": "/sessions/:sessionId", "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.", @@ -2759,6 +2780,7 @@ } ] } + ] }, { @@ -2818,7 +2840,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2867,7 +2890,8 @@ } } ] - }, + } +, { "name": "/paymentLinks/:linkId", "description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", @@ -2923,6 +2947,7 @@ } ] } + ] } ], diff --git a/postman/DataProtectionService-v1.json b/postman/DataProtectionService-v1.json index a2bf614..457c83c 100644 --- a/postman/DataProtectionService-v1.json +++ b/postman/DataProtectionService-v1.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -59,6 +61,7 @@ } ] } + ] } ], diff --git a/postman/DisputeService-v30.json b/postman/DisputeService-v30.json index 4b27046..f70a743 100644 --- a/postman/DisputeService-v30.json +++ b/postman/DisputeService-v30.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/defendDispute", "description": "Defends a specific dispute.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -105,7 +110,8 @@ } } ] - }, + } +, { "name": "/deleteDisputeDefenseDocument", "description": "Deletes a specific dispute defense document that was supplied earlier.", @@ -118,11 +124,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -152,7 +160,8 @@ } } ] - }, + } +, { "name": "/retrieveApplicableDefenseReasons", "description": "Returns a list of all applicable defense reasons to defend a specific dispute.", @@ -165,11 +174,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -199,7 +210,8 @@ } } ] - }, + } +, { "name": "/supplyDefenseDocument", "description": "Supplies a specific dispute defense document.", @@ -212,11 +224,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -247,6 +261,7 @@ } ] } + ] } ], diff --git a/postman/LegalEntityService-v1.json b/postman/LegalEntityService-v1.json index 58fd507..d0415e4 100644 --- a/postman/LegalEntityService-v1.json +++ b/postman/LegalEntityService-v1.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -70,16 +73,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -116,16 +122,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -162,16 +171,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -201,7 +213,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id", "description": "Returns a legal entity.", @@ -214,6 +227,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -249,7 +263,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id", "description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.", @@ -262,16 +277,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -314,16 +332,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -359,7 +380,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/businessLines", "description": "Returns the business lines owned by a legal entity.", @@ -372,6 +394,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -409,6 +432,7 @@ } ] } + ] }, { @@ -426,11 +450,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -467,7 +493,8 @@ } } ] - }, + } +, { "name": "/themes", "description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding, [only use v2](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-01-legal-entity-management-api-3) for your API requests. ", @@ -480,6 +507,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -509,7 +537,8 @@ } } ] - }, + } +, { "name": "/themes/:id", "description": "Returns the details of the theme identified in the path.>If you are using hosted onboarding, [only use v2](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-01-legal-entity-management-api-3) for your API requests. ", @@ -522,6 +551,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -558,6 +588,7 @@ } ] } + ] }, { @@ -575,11 +606,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -616,11 +649,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -650,7 +685,8 @@ } } ] - }, + } +, { "name": "/businessLines/:id", "description": "Deletes a business line. >If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts.", @@ -663,6 +699,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -698,7 +735,8 @@ } } ] - }, + } +, { "name": "/businessLines/:id", "description": "Returns the detail of a business line.", @@ -711,6 +749,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -747,6 +786,7 @@ } ] } + ] }, { @@ -764,16 +804,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -803,7 +846,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Deletes a document.", @@ -816,6 +860,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -851,7 +896,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Returns a document.", @@ -864,6 +910,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -899,7 +946,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs.", @@ -912,16 +960,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the document. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -958,6 +1009,7 @@ } ] } + ] }, { @@ -975,11 +1027,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1016,7 +1070,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/termsOfService/:termsofservicedocumentid", "description": "Accepts Terms of Service.", @@ -1029,11 +1084,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1076,7 +1133,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/termsOfServiceAcceptanceInfos", "description": "Returns Terms of Service information for a legal entity.", @@ -1089,6 +1147,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1125,7 +1184,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/termsOfServiceStatus", "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity.", @@ -1138,6 +1198,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1175,6 +1236,7 @@ } ] } + ] }, { @@ -1192,16 +1254,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1238,16 +1303,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1277,7 +1345,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Deletes a transfer instrument.", @@ -1290,6 +1359,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1325,7 +1395,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Returns the details of a transfer instrument.", @@ -1338,6 +1409,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1373,7 +1445,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Updates a transfer instrument.", @@ -1386,16 +1459,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the transfer instrument. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1432,6 +1508,7 @@ } ] } + ] }, { @@ -1449,6 +1526,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1485,7 +1563,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/pciQuestionnaires/:pciid", "description": "Returns the signed PCI questionnaire.", @@ -1498,6 +1577,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1540,7 +1620,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/pciQuestionnaires/generatePciTemplates", "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).", @@ -1553,11 +1634,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1595,7 +1678,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/pciQuestionnaires/signPciTemplates", "description": "Signs the required PCI questionnaire.", @@ -1608,11 +1692,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1651,6 +1737,7 @@ } ] } + ] } ], diff --git a/postman/LegalEntityService-v2.json b/postman/LegalEntityService-v2.json index 1fd91f6..90d0cb9 100644 --- a/postman/LegalEntityService-v2.json +++ b/postman/LegalEntityService-v2.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -70,16 +73,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -116,16 +122,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -162,16 +171,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -208,16 +220,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -254,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -300,16 +318,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -339,7 +360,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id", "description": "Returns a legal entity.", @@ -352,6 +374,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -387,7 +410,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id", "description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.", @@ -400,16 +424,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -452,16 +479,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -504,16 +534,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -556,16 +589,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -608,16 +644,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -653,7 +692,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/businessLines", "description": "Returns the business lines owned by a legal entity.", @@ -666,6 +706,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -703,6 +744,58 @@ } ] } +, + { + "name": "/legalEntities/:id/confirmDataReview", + "description": "Confirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request.", + "item": [ + { + "name": "Confirm data review", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/confirmDataReview", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "confirmDataReview" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Confirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request." + } + } + ] + } + ] }, { @@ -720,11 +813,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -761,7 +856,8 @@ } } ] - }, + } +, { "name": "/themes", "description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding, [only use v2](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-01-legal-entity-management-api-3) for your API requests. ", @@ -774,6 +870,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -803,7 +900,8 @@ } } ] - }, + } +, { "name": "/themes/:id", "description": "Returns the details of the theme identified in the path.>If you are using hosted onboarding, [only use v2](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-01-legal-entity-management-api-3) for your API requests. ", @@ -816,6 +914,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -852,6 +951,7 @@ } ] } + ] }, { @@ -869,11 +969,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -903,7 +1005,8 @@ } } ] - }, + } +, { "name": "/businessLines/:id", "description": "Deletes a business line. >If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts.", @@ -916,6 +1019,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -951,7 +1055,8 @@ } } ] - }, + } +, { "name": "/businessLines/:id", "description": "Returns the detail of a business line.", @@ -964,6 +1069,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -999,7 +1105,8 @@ } } ] - }, + } +, { "name": "/businessLines/:id", "description": "Updates a business line.", @@ -1012,11 +1119,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1053,6 +1162,7 @@ } ] } + ] }, { @@ -1070,16 +1180,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1109,7 +1222,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Deletes a document.", @@ -1122,6 +1236,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1157,7 +1272,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Returns a document.", @@ -1170,6 +1286,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1205,7 +1322,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs.", @@ -1218,16 +1336,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the document. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1264,6 +1385,7 @@ } ] } + ] }, { @@ -1281,11 +1403,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1322,7 +1446,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/termsOfService/:termsofservicedocumentid", "description": "Accepts Terms of Service.", @@ -1335,11 +1460,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1382,7 +1509,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/termsOfServiceAcceptanceInfos", "description": "Returns Terms of Service information for a legal entity.", @@ -1395,6 +1523,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1431,7 +1560,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/termsOfServiceStatus", "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity.", @@ -1444,6 +1574,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1481,6 +1612,7 @@ } ] } + ] }, { @@ -1498,16 +1630,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1544,16 +1679,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1583,7 +1721,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Deletes a transfer instrument.", @@ -1596,6 +1735,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1631,7 +1771,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Returns the details of a transfer instrument.", @@ -1644,6 +1785,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1679,7 +1821,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Updates a transfer instrument.", @@ -1692,16 +1835,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the transfer instrument. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1738,6 +1884,7 @@ } ] } + ] }, { @@ -1755,6 +1902,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1791,7 +1939,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/pciQuestionnaires/:pciid", "description": "Returns the signed PCI questionnaire.", @@ -1804,6 +1953,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1846,7 +1996,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/pciQuestionnaires/generatePciTemplates", "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).", @@ -1859,11 +2010,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1901,7 +2054,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/pciQuestionnaires/signPciTemplates", "description": "Signs the required PCI questionnaire.", @@ -1914,11 +2068,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1957,6 +2113,7 @@ } ] } + ] } ], diff --git a/postman/LegalEntityService-v3.json b/postman/LegalEntityService-v3.json index fadfc9f..b2113e9 100644 --- a/postman/LegalEntityService-v3.json +++ b/postman/LegalEntityService-v3.json @@ -24,16 +24,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -70,16 +73,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -116,16 +122,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -162,16 +171,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -208,16 +220,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -254,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -300,16 +318,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -339,7 +360,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id", "description": "Returns a legal entity.", @@ -352,6 +374,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -387,7 +410,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id", "description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.", @@ -400,16 +424,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -452,16 +479,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -504,16 +534,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -556,16 +589,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -608,16 +644,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -653,7 +692,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/businessLines", "description": "Returns the business lines owned by a legal entity.", @@ -666,6 +706,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -702,7 +743,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/checkVerificationErrors", "description": "Returns the verification errors for a legal entity and its supporting entities.", @@ -715,6 +757,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -752,6 +795,58 @@ } ] } +, + { + "name": "/legalEntities/:id/confirmDataReview", + "description": "Confirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request.", + "item": [ + { + "name": "Confirm data review", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/confirmDataReview", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "confirmDataReview" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Confirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request." + } + } + ] + } + ] }, { @@ -769,11 +864,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -810,7 +907,8 @@ } } ] - }, + } +, { "name": "/themes", "description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding, [only use v2](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-01-legal-entity-management-api-3) for your API requests. ", @@ -823,6 +921,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -852,7 +951,8 @@ } } ] - }, + } +, { "name": "/themes/:id", "description": "Returns the details of the theme identified in the path.>If you are using hosted onboarding, [only use v2](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-01-legal-entity-management-api-3) for your API requests. ", @@ -865,6 +965,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -901,6 +1002,7 @@ } ] } + ] }, { @@ -918,11 +1020,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -959,11 +1063,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -993,7 +1099,8 @@ } } ] - }, + } +, { "name": "/businessLines/:id", "description": "Deletes a business line. >If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts.", @@ -1006,6 +1113,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1041,7 +1149,8 @@ } } ] - }, + } +, { "name": "/businessLines/:id", "description": "Returns the detail of a business line.", @@ -1054,6 +1163,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1089,7 +1199,8 @@ } } ] - }, + } +, { "name": "/businessLines/:id", "description": "Updates a business line.", @@ -1102,11 +1213,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1143,6 +1256,7 @@ } ] } + ] }, { @@ -1160,16 +1274,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1199,7 +1316,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Deletes a document.", @@ -1212,6 +1330,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1247,7 +1366,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Returns a document.", @@ -1260,6 +1380,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1295,7 +1416,8 @@ } } ] - }, + } +, { "name": "/documents/:id", "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs.", @@ -1308,16 +1430,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the document. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1354,6 +1479,7 @@ } ] } + ] }, { @@ -1371,11 +1497,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1412,7 +1540,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/termsOfService/:termsofservicedocumentid", "description": "Accepts Terms of Service.", @@ -1425,11 +1554,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1472,7 +1603,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/termsOfServiceAcceptanceInfos", "description": "Returns Terms of Service information for a legal entity.", @@ -1485,6 +1617,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1521,7 +1654,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/termsOfServiceStatus", "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity.", @@ -1534,6 +1668,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1571,6 +1706,7 @@ } ] } + ] }, { @@ -1588,16 +1724,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1634,16 +1773,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1673,7 +1815,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Deletes a transfer instrument.", @@ -1686,6 +1829,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1721,7 +1865,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Returns the details of a transfer instrument.", @@ -1734,6 +1879,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1769,7 +1915,8 @@ } } ] - }, + } +, { "name": "/transferInstruments/:id", "description": "Updates a transfer instrument.", @@ -1782,16 +1929,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "x-requested-verification-code", "value": "", + "description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the transfer instrument. Requested verification codes can only be used in your test environment.", "disabled": true } ], @@ -1828,6 +1978,7 @@ } ] } + ] }, { @@ -1845,6 +1996,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1881,7 +2033,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/pciQuestionnaires/:pciid", "description": "Returns the signed PCI questionnaire.", @@ -1894,6 +2047,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1936,7 +2090,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/pciQuestionnaires/generatePciTemplates", "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).", @@ -1949,11 +2104,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1991,7 +2148,8 @@ } } ] - }, + } +, { "name": "/legalEntities/:id/pciQuestionnaires/signPciTemplates", "description": "Signs the required PCI questionnaire.", @@ -2004,11 +2162,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2047,6 +2207,7 @@ } ] } + ] } ], diff --git a/postman/ManagementService-v1.json b/postman/ManagementService-v1.json index 152d888..39aae42 100644 --- a/postman/ManagementService-v1.json +++ b/postman/ManagementService-v1.json @@ -24,6 +24,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -68,6 +69,7 @@ } ] } + ] }, { @@ -85,6 +87,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -110,11 +113,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/merchants", "description": "Creates a merchant account for the company account specified in the request. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write", @@ -135,11 +143,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -169,7 +179,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId", "description": "Returns the merchant account specified in the path. Your API credential must have access to the merchant account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", @@ -182,6 +193,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -217,7 +229,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/activate", "description": "Sends a request to activate the merchant account identified in the path. You get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write", @@ -230,6 +243,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -267,6 +281,7 @@ } ] } + ] }, { @@ -284,6 +299,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -320,7 +336,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations", "description": "Creates a split configuration for the merchant account specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -333,11 +350,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -374,7 +393,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "description": "Deletes the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -387,6 +407,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -429,7 +450,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "description": "Returns the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -442,6 +464,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -484,7 +507,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "description": "Changes the description of the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -497,11 +521,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -544,7 +570,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "description": "Creates a rule in the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -557,11 +584,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -604,7 +633,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", "description": "Deletes the split configuration rule specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -617,6 +647,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -666,7 +697,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", "description": "Changes the conditions of the split configuration rule specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -679,11 +711,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -733,7 +767,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId", "description": "Changes the split logic specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -746,11 +781,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -808,6 +845,7 @@ } ] } + ] }, { @@ -825,6 +863,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -868,7 +907,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", "description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -881,11 +921,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -929,7 +971,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -942,6 +985,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -991,7 +1035,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -1004,6 +1049,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1054,6 +1100,7 @@ } ] } + ] }, { @@ -1071,6 +1118,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1115,6 +1163,7 @@ } ] } + ] }, { @@ -1132,6 +1181,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1176,6 +1226,7 @@ } ] } + ] }, { @@ -1193,6 +1244,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1225,15 +1277,21 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to return.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.", + "disabled": true }, { "key": "username", - "value": "username_example" + "value": "username_example", + "description": "The partial or complete username to select all users that match.", + "disabled": true } ] }, @@ -1241,7 +1299,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/users", "description": "Creates the user for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -1254,11 +1313,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1295,7 +1356,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/users/:userId", "description": "Returns user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -1308,6 +1370,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1350,7 +1413,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/users/:userId", "description": "Updates user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -1363,11 +1427,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1411,6 +1477,7 @@ } ] } + ] }, { @@ -1428,11 +1495,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1470,11 +1539,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1512,11 +1583,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1548,6 +1621,7 @@ } ] } + ] }, { @@ -1565,6 +1639,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1601,7 +1676,8 @@ } } ] - }, + } +, { "name": "/terminals/:terminalId/terminalLogos", "description": "Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -1614,11 +1690,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1662,11 +1740,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1703,7 +1783,8 @@ } } ] - }, + } +, { "name": "/terminals/:terminalId/terminalSettings", "description": "Returns the settings that are configured for the payment terminal identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -1716,6 +1797,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1752,7 +1834,8 @@ } } ] - }, + } +, { "name": "/terminals/:terminalId/terminalSettings", "description": "Updates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -1765,11 +1848,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1813,11 +1898,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1855,6 +1942,7 @@ } ] } + ] }, { @@ -1872,6 +1960,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1908,7 +1997,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/payoutSettings", "description": "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting. If you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write", @@ -1921,11 +2011,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1962,7 +2054,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/payoutSettings/:payoutSettingsId", "description": "Deletes the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write", @@ -1975,6 +2068,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2017,7 +2111,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/payoutSettings/:payoutSettingsId", "description": "Returns the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read", @@ -2030,6 +2125,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2072,7 +2168,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/payoutSettings/:payoutSettingsId", "description": "Updates the payout setting identified in the path. You can enable or disable the payout setting. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write", @@ -2085,11 +2182,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2133,6 +2232,7 @@ } ] } + ] }, { @@ -2150,6 +2250,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2182,11 +2283,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -2194,7 +2299,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks", "description": "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2207,11 +2313,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2248,7 +2356,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId", "description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2261,6 +2370,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2303,7 +2413,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId", "description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write", @@ -2316,6 +2427,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2358,7 +2470,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId", "description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2371,11 +2484,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2418,7 +2533,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId/generateHmac", "description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2431,6 +2547,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2474,7 +2591,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId/test", "description": "Sends sample notifications to test if the webhook is set up correctly. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2487,11 +2605,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2536,6 +2656,7 @@ } ] } + ] }, { @@ -2553,6 +2674,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2597,6 +2719,7 @@ } ] } + ] }, { @@ -2614,6 +2737,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2657,7 +2781,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", "description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -2670,11 +2795,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2718,7 +2845,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -2731,6 +2859,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2780,7 +2909,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -2793,6 +2923,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2843,6 +2974,7 @@ } ] } + ] }, { @@ -2860,6 +2992,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2892,7 +3025,9 @@ "query": [ { "key": "name", - "value": "name_example" + "value": "name_example", + "description": "The name of the billing entity.", + "disabled": true } ] }, @@ -2900,7 +3035,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/shippingLocations", "description": "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -2913,6 +3049,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2945,15 +3082,21 @@ "query": [ { "key": "name", - "value": "name_example" + "value": "name_example", + "description": "The name of the shipping location.", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of locations to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of locations to return.", + "disabled": true } ] }, @@ -2961,7 +3104,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/shippingLocations", "description": "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -2974,11 +3118,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3015,7 +3161,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalModels", "description": "Returns a list of payment terminal models that the company identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -3028,6 +3175,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3064,7 +3212,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders", "description": "Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -3077,6 +3226,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3109,19 +3259,27 @@ "query": [ { "key": "customerOrderReference", - "value": "customerOrderReference_example" + "value": "customerOrderReference_example", + "description": "Your purchase order number.", + "disabled": true }, { "key": "status", - "value": "status_example" + "value": "status_example", + "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of orders to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of orders to return.", + "disabled": true } ] }, @@ -3129,7 +3287,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders", "description": "Creates an order for payment terminal products for the company identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write >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.", @@ -3142,11 +3301,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3183,7 +3344,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders/:orderId", "description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -3196,6 +3358,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3238,7 +3401,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders/:orderId", "description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -3251,11 +3415,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3298,7 +3464,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders/:orderId/cancel", "description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -3311,6 +3478,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3354,7 +3522,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalProducts", "description": "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -3367,6 +3536,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3399,19 +3569,27 @@ "query": [ { "key": "country", - "value": "country_example" + "value": "country_example", + "description": "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**", + "disabled": false }, { "key": "terminalModelId", - "value": "terminalModelId_example" + "value": "terminalModelId_example", + "description": "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) response. For example, **Verifone.M400**", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of products to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of products to return.", + "disabled": true } ] }, @@ -3420,6 +3598,7 @@ } ] } + ] }, { @@ -3437,6 +3616,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3469,11 +3649,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -3481,7 +3665,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials", "description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential. The response includes the: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -3494,11 +3679,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3535,7 +3722,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId", "description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -3548,6 +3736,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3590,7 +3779,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId", "description": "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -3603,11 +3793,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3651,6 +3843,7 @@ } ] } + ] }, { @@ -3668,6 +3861,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3700,15 +3894,21 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.", + "disabled": true }, { "key": "username", - "value": "username_example" + "value": "username_example", + "description": "The partial or complete username to select all users that match.", + "disabled": true } ] }, @@ -3716,7 +3916,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/users", "description": "Creates a user for the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -3729,11 +3930,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3770,7 +3973,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/users/:userId", "description": "Returns user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -3783,6 +3987,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3825,7 +4030,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/users/:userId", "description": "Updates user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -3838,11 +4044,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3886,6 +4094,7 @@ } ] } + ] }, { @@ -3903,6 +4112,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3935,19 +4145,27 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true }, { "key": "status", - "value": "status_example" + "value": "status_example", + "description": "Returns terminal actions with the specified status. Allowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**.", + "disabled": true }, { "key": "type", - "value": "type_example" + "value": "type_example", + "description": "Returns terminal actions of the specified type. Allowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.", + "disabled": true } ] }, @@ -3955,7 +4173,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalActions/:actionId", "description": "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write", @@ -3968,6 +4187,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4011,6 +4231,7 @@ } ] } + ] }, { @@ -4028,6 +4249,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4060,19 +4282,27 @@ "query": [ { "key": "storeId", - "value": "storeId_example" + "value": "storeId_example", + "description": "The unique identifier of the store for which to return the payment methods.", + "disabled": true }, { "key": "businessLineId", - "value": "businessLineId_example" + "value": "businessLineId_example", + "description": "The unique identifier of the Business Line for which to return the payment methods.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true }, { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true } ] }, @@ -4080,7 +4310,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings", "description": "Sends a request to add a new payment method to the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ", @@ -4093,11 +4324,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4141,11 +4374,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4182,7 +4417,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", "description": "Returns details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ", @@ -4195,6 +4431,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4237,7 +4474,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", "description": "Updates payment method details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ", @@ -4250,11 +4488,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4297,7 +4537,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains", "description": "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ", @@ -4310,11 +4551,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4358,7 +4601,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains", "description": "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ", @@ -4371,6 +4615,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4415,6 +4660,7 @@ } ] } + ] }, { @@ -4432,6 +4678,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4461,7 +4708,8 @@ } } ] - }, + } +, { "name": "/me/allowedOrigins", "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request. You can make this request with any of the Management API roles.", @@ -4474,6 +4722,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4504,7 +4753,8 @@ } } ] - }, + } +, { "name": "/me/allowedOrigins", "description": "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.", @@ -4517,11 +4767,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4552,7 +4804,8 @@ } } ] - }, + } +, { "name": "/me/allowedOrigins/:originId", "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.", @@ -4565,6 +4818,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4601,7 +4855,8 @@ } } ] - }, + } +, { "name": "/me/allowedOrigins/:originId", "description": "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.", @@ -4614,6 +4869,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4650,7 +4906,8 @@ } } ] - }, + } +, { "name": "/me/generateClientKey", "description": "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/) used to authenticate requests from your payment environment. 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 [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -4663,6 +4920,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4694,6 +4952,7 @@ } ] } + ] }, { @@ -4711,6 +4970,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4743,7 +5003,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -4751,7 +5013,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalLogos", "description": "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the company account, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -4764,11 +5027,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4801,7 +5066,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Allowed values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -4816,11 +5083,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4853,7 +5122,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Allowed values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -4861,7 +5132,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalSettings", "description": "Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", @@ -4874,6 +5146,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4910,7 +5183,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalSettings", "description": "Updates payment terminal settings for the merchant account identified in the path. These settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -4923,11 +5197,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4971,11 +5247,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5013,6 +5291,7 @@ } ] } + ] }, { @@ -5030,6 +5309,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5055,35 +5335,51 @@ "query": [ { "key": "searchQuery", - "value": "searchQuery_example" + "value": "searchQuery_example", + "description": "Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored.", + "disabled": true }, { "key": "otpQuery", - "value": "otpQuery_example" + "value": "otpQuery_example", + "description": "Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored.", + "disabled": true }, { "key": "countries", - "value": "countries_example" + "value": "countries_example", + "description": "Returns terminals located in the countries specified by their [two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", + "disabled": true }, { "key": "merchantIds", - "value": "merchantIds_example" + "value": "merchantIds_example", + "description": "Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.", + "disabled": true }, { "key": "storeIds", - "value": "storeIds_example" + "value": "storeIds_example", + "description": "Returns terminals that are assigned to the [stores](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores) specified by their unique store ID.", + "disabled": true }, { "key": "brandModels", - "value": "brandModels_example" + "value": "brandModels_example", + "description": "Returns terminals of the [models](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) specified in the format *brand.model*.", + "disabled": true }, { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true } ] }, @@ -5092,6 +5388,7 @@ } ] } + ] }, { @@ -5109,6 +5406,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5141,11 +5439,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -5153,7 +5455,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks", "description": "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5166,11 +5469,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5207,7 +5512,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId", "description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5220,6 +5526,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5262,7 +5569,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId", "description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write", @@ -5275,6 +5583,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5317,7 +5626,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId", "description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5330,11 +5640,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5377,7 +5689,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId/generateHmac", "description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5390,6 +5703,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5433,7 +5747,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId/test", "description": "Sends sample notifications to test if the webhook is set up correctly. We send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5446,11 +5761,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5495,6 +5812,7 @@ } ] } + ] }, { @@ -5512,6 +5830,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5544,15 +5863,21 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true }, { "key": "reference", - "value": "reference_example" + "value": "reference_example", + "description": "The reference of the store.", + "disabled": true } ] }, @@ -5560,7 +5885,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores", "description": "Creates a store for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", @@ -5573,11 +5899,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5614,7 +5942,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:storeId", "description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", @@ -5627,6 +5956,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5669,7 +5999,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:storeId", "description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", @@ -5682,11 +6013,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5736,11 +6069,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5783,7 +6118,8 @@ } } ] - }, + } +, { "name": "/stores", "description": "Returns a list of stores. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", @@ -5796,6 +6132,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5821,19 +6158,27 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true }, { "key": "reference", - "value": "reference_example" + "value": "reference_example", + "description": "The reference of the store.", + "disabled": true }, { "key": "merchantId", - "value": "merchantId_example" + "value": "merchantId_example", + "description": "The unique identifier of the merchant account.", + "disabled": true } ] }, @@ -5841,7 +6186,8 @@ } } ] - }, + } +, { "name": "/stores", "description": "Creates a store for the merchant account specified in the request. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", @@ -5854,11 +6200,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5888,7 +6236,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId", "description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", @@ -5901,6 +6250,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5936,7 +6286,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId", "description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", @@ -5949,11 +6300,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5996,11 +6349,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6037,6 +6392,7 @@ } ] } + ] }, { @@ -6054,6 +6410,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6086,19 +6443,27 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true }, { "key": "packageName", - "value": "packageName_example" + "value": "packageName_example", + "description": "The package name that uniquely identifies the Android app.", + "disabled": true }, { "key": "versionCode", - "value": "56" + "value": "56", + "description": "The version number of the app.", + "disabled": true } ] }, @@ -6106,7 +6471,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/androidApps/:id", "description": "Returns the details of the Android app identified in the path. These apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write", @@ -6119,6 +6485,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6161,7 +6528,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/androidCertificates", "description": "Returns a list of the Android certificates that are available for the company identified in the path. Typically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write * Management API—Terminal actions read * Management API—Terminal actions read and write", @@ -6174,6 +6542,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6206,15 +6575,21 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true }, { "key": "certificateName", - "value": "certificateName_example" + "value": "certificateName_example", + "description": "The name of the certificate.", + "disabled": true } ] }, @@ -6223,6 +6598,7 @@ } ] } + ] }, { @@ -6240,6 +6616,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6272,7 +6649,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -6280,7 +6659,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalLogos", "description": "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the Adyen PSP level, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -6293,11 +6673,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6330,7 +6712,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -6345,11 +6729,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6382,7 +6768,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -6390,7 +6778,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalSettings", "description": "Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -6403,6 +6792,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6439,7 +6829,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalSettings", "description": "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -6452,11 +6843,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6500,11 +6893,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6542,6 +6937,7 @@ } ] } + ] }, { @@ -6559,6 +6955,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6591,11 +6988,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -6603,7 +7004,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials", "description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins. The response includes several types of authentication details: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -6616,11 +7018,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6657,7 +7061,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId", "description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -6670,6 +7075,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6712,7 +7118,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId", "description": "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -6725,11 +7132,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6773,6 +7182,7 @@ } ] } + ] }, { @@ -6790,6 +7200,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6822,7 +7233,9 @@ "query": [ { "key": "name", - "value": "name_example" + "value": "name_example", + "description": "The name of the billing entity.", + "disabled": true } ] }, @@ -6830,7 +7243,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/shippingLocations", "description": "Returns the shipping locations for the merchant account identified in the path. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -6843,6 +7257,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6875,15 +7290,21 @@ "query": [ { "key": "name", - "value": "name_example" + "value": "name_example", + "description": "The name of the shipping location.", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of locations to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of locations to return.", + "disabled": true } ] }, @@ -6891,7 +7312,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/shippingLocations", "description": "Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -6904,11 +7326,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6945,7 +7369,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalModels", "description": "Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -6958,6 +7383,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6994,7 +7420,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders", "description": "Returns a list of terminal products orders for the merchant account identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -7007,6 +7434,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7039,19 +7467,27 @@ "query": [ { "key": "customerOrderReference", - "value": "customerOrderReference_example" + "value": "customerOrderReference_example", + "description": "Your purchase order number.", + "disabled": true }, { "key": "status", - "value": "status_example" + "value": "status_example", + "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of orders to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of orders to return.", + "disabled": true } ] }, @@ -7059,7 +7495,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders", "description": "Creates an order for payment terminal products for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write >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.", @@ -7072,11 +7509,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7113,7 +7552,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders/:orderId", "description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -7126,6 +7566,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7168,7 +7609,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders/:orderId", "description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -7181,11 +7623,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7228,7 +7672,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders/:orderId/cancel", "description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -7241,6 +7686,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7284,7 +7730,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalProducts", "description": "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -7297,6 +7744,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7329,19 +7777,27 @@ "query": [ { "key": "country", - "value": "country_example" + "value": "country_example", + "description": "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**", + "disabled": false }, { "key": "terminalModelId", - "value": "terminalModelId_example" + "value": "terminalModelId_example", + "description": "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/merchants/{merchantId}/terminalModels) response. For example, **Verifone.M400**", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of products to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of products to return.", + "disabled": true } ] }, @@ -7350,6 +7806,7 @@ } ] } + ] }, { @@ -7367,6 +7824,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7392,11 +7850,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -7404,7 +7866,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId", "description": "Returns the company account specified in the path. Your API credential must have access to the company account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", @@ -7417,6 +7880,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7452,7 +7916,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/merchants", "description": "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", @@ -7465,6 +7930,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7497,11 +7963,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -7510,6 +7980,7 @@ } ] } + ] }, { @@ -7527,6 +7998,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7566,7 +8038,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -7574,7 +8048,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:reference/terminalLogos", "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -7587,11 +8062,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7631,7 +8108,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T", + "disabled": false } ] }, @@ -7646,11 +8125,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7690,7 +8171,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T", + "disabled": false } ] }, @@ -7698,7 +8181,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:reference/terminalSettings", "description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -7711,6 +8195,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7754,7 +8239,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:reference/terminalSettings", "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -7767,11 +8253,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7822,11 +8310,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7870,7 +8360,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId/terminalLogos", "description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", @@ -7883,6 +8374,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7915,7 +8407,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -7923,7 +8417,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId/terminalLogos", "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -7936,11 +8431,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7973,7 +8470,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -7988,11 +8487,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8025,7 +8526,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -8033,7 +8536,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId/terminalSettings", "description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -8046,6 +8550,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8082,7 +8587,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId/terminalSettings", "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -8095,11 +8601,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8143,11 +8651,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8185,6 +8695,7 @@ } ] } + ] } ], diff --git a/postman/ManagementService-v3.json b/postman/ManagementService-v3.json index dad1bef..29b6248 100644 --- a/postman/ManagementService-v3.json +++ b/postman/ManagementService-v3.json @@ -24,6 +24,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -68,6 +69,7 @@ } ] } + ] }, { @@ -85,6 +87,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -110,11 +113,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -122,7 +129,8 @@ } } ] - }, + } +, { "name": "/merchants", "description": "Creates a merchant account for the company account specified in the request. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write", @@ -135,11 +143,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -169,7 +179,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId", "description": "Returns the merchant account specified in the path. Your API credential must have access to the merchant account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", @@ -182,6 +193,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -217,7 +229,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/activate", "description": "Sends a request to activate the merchant account identified in the path. You get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write", @@ -230,6 +243,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -267,6 +281,7 @@ } ] } + ] }, { @@ -284,6 +299,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -320,7 +336,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations", "description": "Creates a split configuration for the merchant account specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -333,11 +350,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -374,7 +393,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "description": "Deletes the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -387,6 +407,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -429,7 +450,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "description": "Returns the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -442,6 +464,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -484,7 +507,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "description": "Changes the description of the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -497,11 +521,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -544,7 +570,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "description": "Creates a rule in the split configuration specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -557,11 +584,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -604,7 +633,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", "description": "Deletes the split configuration rule specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -617,6 +647,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -666,7 +697,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", "description": "Changes the conditions of the split configuration rule specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -679,11 +711,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -733,7 +767,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId", "description": "Changes the split logic specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API - SplitConfiguration read and write", @@ -746,11 +781,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -808,6 +845,7 @@ } ] } + ] }, { @@ -825,6 +863,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -868,7 +907,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", "description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -881,11 +921,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -929,7 +971,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -942,6 +985,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -991,7 +1035,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -1004,6 +1049,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1054,6 +1100,7 @@ } ] } + ] }, { @@ -1071,6 +1118,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1115,6 +1163,7 @@ } ] } + ] }, { @@ -1132,6 +1181,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1176,6 +1226,7 @@ } ] } + ] }, { @@ -1193,6 +1244,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1225,15 +1277,21 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to return.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.", + "disabled": true }, { "key": "username", - "value": "username_example" + "value": "username_example", + "description": "The partial or complete username to select all users that match.", + "disabled": true } ] }, @@ -1241,7 +1299,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/users", "description": "Creates the user for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -1254,11 +1313,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1295,7 +1356,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/users/:userId", "description": "Returns user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -1308,6 +1370,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1350,7 +1413,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/users/:userId", "description": "Updates user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -1363,11 +1427,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1411,6 +1477,7 @@ } ] } + ] }, { @@ -1428,11 +1495,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1470,11 +1539,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1512,11 +1583,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1548,6 +1621,7 @@ } ] } + ] }, { @@ -1565,6 +1639,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1601,7 +1676,8 @@ } } ] - }, + } +, { "name": "/terminals/:terminalId/terminalLogos", "description": "Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -1614,11 +1690,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1662,11 +1740,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1703,7 +1783,8 @@ } } ] - }, + } +, { "name": "/terminals/:terminalId/terminalSettings", "description": "Returns the settings that are configured for the payment terminal identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -1716,6 +1797,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1752,7 +1834,8 @@ } } ] - }, + } +, { "name": "/terminals/:terminalId/terminalSettings", "description": "Updates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -1765,11 +1848,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1813,11 +1898,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1855,6 +1942,7 @@ } ] } + ] }, { @@ -1872,6 +1960,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1908,7 +1997,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/payoutSettings", "description": "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting. If you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write", @@ -1921,11 +2011,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -1962,7 +2054,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/payoutSettings/:payoutSettingsId", "description": "Deletes the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write", @@ -1975,6 +2068,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2017,7 +2111,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/payoutSettings/:payoutSettingsId", "description": "Returns the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read", @@ -2030,6 +2125,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2072,7 +2168,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/payoutSettings/:payoutSettingsId", "description": "Updates the payout setting identified in the path. You can enable or disable the payout setting. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write", @@ -2085,11 +2182,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2133,6 +2232,7 @@ } ] } + ] }, { @@ -2150,6 +2250,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2182,11 +2283,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -2194,7 +2299,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks", "description": "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2207,11 +2313,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2248,7 +2356,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId", "description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2261,6 +2370,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2303,7 +2413,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId", "description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write", @@ -2316,6 +2427,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2358,7 +2470,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId", "description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2371,11 +2484,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2418,7 +2533,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId/generateHmac", "description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2431,6 +2547,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2474,7 +2591,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/webhooks/:webhookId/test", "description": "Sends sample notifications to test if the webhook is set up correctly. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -2487,11 +2605,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2536,6 +2656,7 @@ } ] } + ] }, { @@ -2553,6 +2674,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2597,6 +2719,7 @@ } ] } + ] }, { @@ -2614,6 +2737,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2657,7 +2781,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", "description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -2670,11 +2795,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2718,7 +2845,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -2731,6 +2859,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2780,7 +2909,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -2793,6 +2923,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2843,6 +2974,7 @@ } ] } + ] }, { @@ -2860,6 +2992,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2892,7 +3025,9 @@ "query": [ { "key": "name", - "value": "name_example" + "value": "name_example", + "description": "The name of the billing entity.", + "disabled": true } ] }, @@ -2900,7 +3035,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/shippingLocations", "description": "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -2913,6 +3049,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -2945,15 +3082,21 @@ "query": [ { "key": "name", - "value": "name_example" + "value": "name_example", + "description": "The name of the shipping location.", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of locations to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of locations to return.", + "disabled": true } ] }, @@ -2961,7 +3104,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/shippingLocations", "description": "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -2974,11 +3118,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3015,7 +3161,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalModels", "description": "Returns a list of payment terminal models that the company identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -3028,6 +3175,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3064,7 +3212,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders", "description": "Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -3077,6 +3226,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3109,19 +3259,27 @@ "query": [ { "key": "customerOrderReference", - "value": "customerOrderReference_example" + "value": "customerOrderReference_example", + "description": "Your purchase order number.", + "disabled": true }, { "key": "status", - "value": "status_example" + "value": "status_example", + "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of orders to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of orders to return.", + "disabled": true } ] }, @@ -3129,7 +3287,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders", "description": "Creates an order for payment terminal products for the company identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write >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.", @@ -3142,11 +3301,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3183,7 +3344,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders/:orderId", "description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -3196,6 +3358,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3238,7 +3401,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders/:orderId", "description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -3251,11 +3415,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3298,7 +3464,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalOrders/:orderId/cancel", "description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -3311,6 +3478,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3354,7 +3522,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalProducts", "description": "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -3367,6 +3536,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3399,19 +3569,27 @@ "query": [ { "key": "country", - "value": "country_example" + "value": "country_example", + "description": "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**", + "disabled": false }, { "key": "terminalModelId", - "value": "terminalModelId_example" + "value": "terminalModelId_example", + "description": "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) response. For example, **Verifone.M400**", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of products to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of products to return.", + "disabled": true } ] }, @@ -3420,6 +3598,7 @@ } ] } + ] }, { @@ -3437,6 +3616,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3469,11 +3649,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -3481,7 +3665,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials", "description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential. The response includes the: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -3494,11 +3679,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3535,7 +3722,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId", "description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -3548,6 +3736,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3590,7 +3779,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/apiCredentials/:apiCredentialId", "description": "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -3603,11 +3793,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3651,6 +3843,7 @@ } ] } + ] }, { @@ -3668,6 +3861,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3700,15 +3894,21 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.", + "disabled": true }, { "key": "username", - "value": "username_example" + "value": "username_example", + "description": "The partial or complete username to select all users that match.", + "disabled": true } ] }, @@ -3716,7 +3916,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/users", "description": "Creates a user for the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -3729,11 +3930,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3770,7 +3973,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/users/:userId", "description": "Returns user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -3783,6 +3987,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3825,7 +4030,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/users/:userId", "description": "Updates user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", @@ -3838,11 +4044,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3886,6 +4094,7 @@ } ] } + ] }, { @@ -3903,6 +4112,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -3935,19 +4145,27 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true }, { "key": "status", - "value": "status_example" + "value": "status_example", + "description": "Returns terminal actions with the specified status. Allowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**.", + "disabled": true }, { "key": "type", - "value": "type_example" + "value": "type_example", + "description": "Returns terminal actions of the specified type. Allowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.", + "disabled": true } ] }, @@ -3955,7 +4173,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalActions/:actionId", "description": "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write", @@ -3968,6 +4187,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4011,6 +4231,7 @@ } ] } + ] }, { @@ -4028,6 +4249,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4060,19 +4282,27 @@ "query": [ { "key": "storeId", - "value": "storeId_example" + "value": "storeId_example", + "description": "The unique identifier of the store for which to return the payment methods.", + "disabled": true }, { "key": "businessLineId", - "value": "businessLineId_example" + "value": "businessLineId_example", + "description": "The unique identifier of the Business Line for which to return the payment methods.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true }, { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true } ] }, @@ -4080,7 +4310,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings", "description": "Sends a request to add a new payment method to the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ", @@ -4093,11 +4324,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4141,11 +4374,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4182,7 +4417,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", "description": "Returns details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ", @@ -4195,6 +4431,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4237,7 +4474,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", "description": "Updates payment method details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ", @@ -4250,11 +4488,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4297,7 +4537,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains", "description": "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ", @@ -4310,11 +4551,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4358,7 +4601,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains", "description": "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ", @@ -4371,6 +4615,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4415,6 +4660,7 @@ } ] } + ] }, { @@ -4432,6 +4678,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4461,7 +4708,8 @@ } } ] - }, + } +, { "name": "/me/allowedOrigins", "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request. You can make this request with any of the Management API roles.", @@ -4474,6 +4722,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4504,7 +4753,8 @@ } } ] - }, + } +, { "name": "/me/allowedOrigins", "description": "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.", @@ -4517,11 +4767,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4552,7 +4804,8 @@ } } ] - }, + } +, { "name": "/me/allowedOrigins/:originId", "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.", @@ -4565,6 +4818,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4601,7 +4855,8 @@ } } ] - }, + } +, { "name": "/me/allowedOrigins/:originId", "description": "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.", @@ -4614,6 +4869,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4650,7 +4906,8 @@ } } ] - }, + } +, { "name": "/me/generateClientKey", "description": "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/) used to authenticate requests from your payment environment. 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 [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -4663,6 +4920,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4694,6 +4952,7 @@ } ] } + ] }, { @@ -4711,6 +4970,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4743,7 +5003,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -4751,7 +5013,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalLogos", "description": "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the company account, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -4764,11 +5027,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4801,7 +5066,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Allowed values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -4816,11 +5083,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4853,7 +5122,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Allowed values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -4861,7 +5132,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalSettings", "description": "Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", @@ -4874,6 +5146,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4910,7 +5183,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalSettings", "description": "Updates payment terminal settings for the merchant account identified in the path. These settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -4923,11 +5197,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -4971,11 +5247,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5013,6 +5291,7 @@ } ] } + ] }, { @@ -5030,6 +5309,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5055,35 +5335,51 @@ "query": [ { "key": "searchQuery", - "value": "searchQuery_example" + "value": "searchQuery_example", + "description": "Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored.", + "disabled": true }, { "key": "otpQuery", - "value": "otpQuery_example" + "value": "otpQuery_example", + "description": "Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored.", + "disabled": true }, { "key": "countries", - "value": "countries_example" + "value": "countries_example", + "description": "Returns terminals located in the countries specified by their [two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", + "disabled": true }, { "key": "merchantIds", - "value": "merchantIds_example" + "value": "merchantIds_example", + "description": "Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.", + "disabled": true }, { "key": "storeIds", - "value": "storeIds_example" + "value": "storeIds_example", + "description": "Returns terminals that are assigned to the [stores](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores) specified by their unique store ID.", + "disabled": true }, { "key": "brandModels", - "value": "brandModels_example" + "value": "brandModels_example", + "description": "Returns terminals of the [models](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) specified in the format *brand.model*.", + "disabled": true }, { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true } ] }, @@ -5091,7 +5387,8 @@ } } ] - }, + } +, { "name": "/terminals/:terminalId/reassign", "description": "Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Assign Terminal", @@ -5104,11 +5401,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5146,6 +5445,7 @@ } ] } + ] }, { @@ -5163,6 +5463,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5195,11 +5496,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -5207,7 +5512,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks", "description": "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5220,11 +5526,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5261,7 +5569,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId", "description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5274,6 +5583,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5316,7 +5626,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId", "description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write", @@ -5329,6 +5640,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5371,7 +5683,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId", "description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5384,11 +5697,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5431,7 +5746,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId/generateHmac", "description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5444,6 +5760,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5487,7 +5804,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/webhooks/:webhookId/test", "description": "Sends sample notifications to test if the webhook is set up correctly. We send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", @@ -5500,11 +5818,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5549,6 +5869,7 @@ } ] } + ] }, { @@ -5566,6 +5887,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5598,15 +5920,21 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true }, { "key": "reference", - "value": "reference_example" + "value": "reference_example", + "description": "The reference of the store.", + "disabled": true } ] }, @@ -5614,7 +5942,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores", "description": "Creates a store for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", @@ -5627,11 +5956,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5668,7 +5999,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:storeId", "description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", @@ -5681,6 +6013,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5723,7 +6056,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:storeId", "description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", @@ -5736,11 +6070,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5790,11 +6126,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5837,7 +6175,8 @@ } } ] - }, + } +, { "name": "/stores", "description": "Returns a list of stores. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", @@ -5850,6 +6189,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5875,19 +6215,27 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true }, { "key": "reference", - "value": "reference_example" + "value": "reference_example", + "description": "The reference of the store.", + "disabled": true }, { "key": "merchantId", - "value": "merchantId_example" + "value": "merchantId_example", + "description": "The unique identifier of the merchant account.", + "disabled": true } ] }, @@ -5895,7 +6243,8 @@ } } ] - }, + } +, { "name": "/stores", "description": "Creates a store for the merchant account specified in the request. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", @@ -5908,11 +6257,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5942,7 +6293,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId", "description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", @@ -5955,6 +6307,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -5990,7 +6343,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId", "description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", @@ -6003,11 +6357,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6050,11 +6406,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6091,6 +6449,7 @@ } ] } + ] }, { @@ -6108,6 +6467,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6140,19 +6500,27 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true }, { "key": "packageName", - "value": "packageName_example" + "value": "packageName_example", + "description": "The package name that uniquely identifies the Android app.", + "disabled": true }, { "key": "versionCode", - "value": "56" + "value": "56", + "description": "The version number of the app.", + "disabled": true } ] }, @@ -6160,7 +6528,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/androidApps", "description": "Uploads an Android APK file to Adyen. The maximum APK file size is 200 MB. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read and write >By choosing to upload, install, or run any third-party applications on an Adyen payment terminal, you accept full responsibility and liability for any consequences of uploading, installing, or running any such applications.", @@ -6173,6 +6542,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6209,7 +6579,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/androidApps/:id", "description": "Returns the details of the Android app identified in the path. These apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write", @@ -6222,6 +6593,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6264,7 +6636,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/androidCertificates", "description": "Returns a list of the Android certificates that are available for the company identified in the path. Typically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Android files read * Management API—Android files read and write * Management API—Terminal actions read * Management API—Terminal actions read and write", @@ -6277,6 +6650,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6309,15 +6683,21 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true }, { "key": "certificateName", - "value": "certificateName_example" + "value": "certificateName_example", + "description": "The name of the certificate.", + "disabled": true } ] }, @@ -6326,6 +6706,7 @@ } ] } + ] }, { @@ -6343,6 +6724,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6375,7 +6757,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -6383,7 +6767,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalLogos", "description": "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the Adyen PSP level, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -6396,11 +6781,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6433,7 +6820,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -6448,11 +6837,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6485,7 +6876,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -6493,7 +6886,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalSettings", "description": "Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -6506,6 +6900,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6542,7 +6937,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/terminalSettings", "description": "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -6555,11 +6951,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6603,11 +7001,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6645,6 +7045,7 @@ } ] } + ] }, { @@ -6662,6 +7063,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6694,11 +7096,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -6706,7 +7112,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials", "description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins. The response includes several types of authentication details: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -6719,11 +7126,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6760,7 +7169,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId", "description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -6773,6 +7183,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6815,7 +7226,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/apiCredentials/:apiCredentialId", "description": "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", @@ -6828,11 +7240,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6876,6 +7290,7 @@ } ] } + ] }, { @@ -6893,6 +7308,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6925,7 +7341,9 @@ "query": [ { "key": "name", - "value": "name_example" + "value": "name_example", + "description": "The name of the billing entity.", + "disabled": true } ] }, @@ -6933,7 +7351,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/shippingLocations", "description": "Returns the shipping locations for the merchant account identified in the path. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -6946,6 +7365,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -6978,15 +7398,21 @@ "query": [ { "key": "name", - "value": "name_example" + "value": "name_example", + "description": "The name of the shipping location.", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of locations to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of locations to return.", + "disabled": true } ] }, @@ -6994,7 +7420,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/shippingLocations", "description": "Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -7007,11 +7434,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7048,7 +7477,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalModels", "description": "Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -7061,6 +7491,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7097,7 +7528,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders", "description": "Returns a list of terminal products orders for the merchant account identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -7110,6 +7542,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7142,19 +7575,27 @@ "query": [ { "key": "customerOrderReference", - "value": "customerOrderReference_example" + "value": "customerOrderReference_example", + "description": "Your purchase order number.", + "disabled": true }, { "key": "status", - "value": "status_example" + "value": "status_example", + "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of orders to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of orders to return.", + "disabled": true } ] }, @@ -7162,7 +7603,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders", "description": "Creates an order for payment terminal products for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write >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.", @@ -7175,11 +7617,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7216,7 +7660,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders/:orderId", "description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -7229,6 +7674,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7271,7 +7717,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders/:orderId", "description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -7284,11 +7731,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7331,7 +7780,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalOrders/:orderId/cancel", "description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", @@ -7344,6 +7794,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7387,7 +7838,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/terminalProducts", "description": "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", @@ -7400,6 +7852,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7432,19 +7885,27 @@ "query": [ { "key": "country", - "value": "country_example" + "value": "country_example", + "description": "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**", + "disabled": false }, { "key": "terminalModelId", - "value": "terminalModelId_example" + "value": "terminalModelId_example", + "description": "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/merchants/{merchantId}/terminalModels) response. For example, **Verifone.M400**", + "disabled": true }, { "key": "offset", - "value": "56" + "value": "56", + "description": "The number of products to skip.", + "disabled": true }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of products to return.", + "disabled": true } ] }, @@ -7453,6 +7914,7 @@ } ] } + ] }, { @@ -7470,6 +7932,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7495,11 +7958,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -7507,7 +7974,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId", "description": "Returns the company account specified in the path. Your API credential must have access to the company account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", @@ -7520,6 +7988,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7555,7 +8024,8 @@ } } ] - }, + } +, { "name": "/companies/:companyId/merchants", "description": "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", @@ -7568,6 +8038,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7600,11 +8071,15 @@ "query": [ { "key": "pageNumber", - "value": "56" + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true }, { "key": "pageSize", - "value": "56" + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true } ] }, @@ -7613,6 +8088,7 @@ } ] } + ] }, { @@ -7630,6 +8106,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7669,7 +8146,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -7677,7 +8156,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:reference/terminalLogos", "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -7690,11 +8170,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7734,7 +8216,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T", + "disabled": false } ] }, @@ -7749,11 +8233,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7793,7 +8279,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T", + "disabled": false } ] }, @@ -7801,7 +8289,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:reference/terminalSettings", "description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -7814,6 +8303,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7857,7 +8347,8 @@ } } ] - }, + } +, { "name": "/merchants/:merchantId/stores/:reference/terminalSettings", "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -7870,11 +8361,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7925,11 +8418,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -7973,7 +8468,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId/terminalLogos", "description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", @@ -7986,6 +8482,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8018,7 +8515,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -8026,7 +8525,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId/terminalLogos", "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", @@ -8039,11 +8539,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8076,7 +8578,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -8091,11 +8595,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8128,7 +8634,9 @@ "query": [ { "key": "model", - "value": "model_example" + "value": "model_example", + "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.", + "disabled": false } ] }, @@ -8136,7 +8644,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId/terminalSettings", "description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -8149,6 +8658,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8185,7 +8695,8 @@ } } ] - }, + } +, { "name": "/stores/:storeId/terminalSettings", "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", @@ -8198,11 +8709,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8246,11 +8759,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -8288,6 +8803,7 @@ } ] } + ] } ], diff --git a/postman/PayoutService-v30.json b/postman/PayoutService-v30.json index 586dfbe..7c0ce87 100644 --- a/postman/PayoutService-v30.json +++ b/postman/PayoutService-v30.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/storeDetailAndSubmitThirdParty", "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -269,7 +282,8 @@ } } ] - }, + } +, { "name": "/submitThirdParty", "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -282,11 +296,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -317,6 +333,7 @@ } ] } + ] }, { @@ -334,11 +351,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -375,11 +394,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -410,6 +431,7 @@ } ] } + ] }, { @@ -427,11 +449,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -461,7 +485,8 @@ } } ] - }, + } +, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -474,11 +499,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -509,6 +536,7 @@ } ] } + ] } ], diff --git a/postman/PayoutService-v40.json b/postman/PayoutService-v40.json index 259a9b1..aaa6b1a 100644 --- a/postman/PayoutService-v40.json +++ b/postman/PayoutService-v40.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/storeDetailAndSubmitThirdParty", "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -269,7 +282,8 @@ } } ] - }, + } +, { "name": "/submitThirdParty", "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -282,11 +296,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -317,6 +333,7 @@ } ] } + ] }, { @@ -334,11 +351,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -375,11 +394,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -410,6 +431,7 @@ } ] } + ] }, { @@ -427,11 +449,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -461,7 +485,8 @@ } } ] - }, + } +, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -474,11 +499,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -509,6 +536,7 @@ } ] } + ] } ], diff --git a/postman/PayoutService-v50.json b/postman/PayoutService-v50.json index 33098c4..3181f3b 100644 --- a/postman/PayoutService-v50.json +++ b/postman/PayoutService-v50.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/storeDetailAndSubmitThirdParty", "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -269,7 +282,8 @@ } } ] - }, + } +, { "name": "/submitThirdParty", "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -282,11 +296,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -317,6 +333,7 @@ } ] } + ] }, { @@ -334,11 +351,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -375,11 +394,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -410,6 +431,7 @@ } ] } + ] }, { @@ -427,11 +449,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -461,7 +485,8 @@ } } ] - }, + } +, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -474,11 +499,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -509,6 +536,7 @@ } ] } + ] } ], diff --git a/postman/PayoutService-v51.json b/postman/PayoutService-v51.json index 2c8dc01..204fb94 100644 --- a/postman/PayoutService-v51.json +++ b/postman/PayoutService-v51.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/storeDetailAndSubmitThirdParty", "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -269,7 +282,8 @@ } } ] - }, + } +, { "name": "/submitThirdParty", "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -282,11 +296,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -317,6 +333,7 @@ } ] } + ] }, { @@ -334,11 +351,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -375,11 +394,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -410,6 +431,7 @@ } ] } + ] }, { @@ -427,11 +449,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -461,7 +485,8 @@ } } ] - }, + } +, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -474,11 +499,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -509,6 +536,7 @@ } ] } + ] } ], diff --git a/postman/PayoutService-v52.json b/postman/PayoutService-v52.json index 476331a..f7f0ee6 100644 --- a/postman/PayoutService-v52.json +++ b/postman/PayoutService-v52.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/storeDetailAndSubmitThirdParty", "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -269,7 +282,8 @@ } } ] - }, + } +, { "name": "/submitThirdParty", "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -282,11 +296,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -317,6 +333,7 @@ } ] } + ] }, { @@ -334,11 +351,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -375,11 +394,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -410,6 +431,7 @@ } ] } + ] }, { @@ -427,11 +449,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -461,7 +485,8 @@ } } ] - }, + } +, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -474,11 +499,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -509,6 +536,7 @@ } ] } + ] } ], diff --git a/postman/PayoutService-v64.json b/postman/PayoutService-v64.json index 62494a5..c68e229 100644 --- a/postman/PayoutService-v64.json +++ b/postman/PayoutService-v64.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/storeDetailAndSubmitThirdParty", "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -269,7 +282,8 @@ } } ] - }, + } +, { "name": "/submitThirdParty", "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -282,11 +296,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -317,6 +333,7 @@ } ] } + ] }, { @@ -334,11 +351,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -375,11 +394,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -410,6 +431,7 @@ } ] } + ] }, { @@ -427,11 +449,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -461,7 +485,8 @@ } } ] - }, + } +, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -474,11 +499,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -509,6 +536,7 @@ } ] } + ] } ], diff --git a/postman/PayoutService-v67.json b/postman/PayoutService-v67.json index ebe9315..33d91e7 100644 --- a/postman/PayoutService-v67.json +++ b/postman/PayoutService-v67.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/storeDetailAndSubmitThirdParty", "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -269,7 +282,8 @@ } } ] - }, + } +, { "name": "/submitThirdParty", "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -282,11 +296,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -317,6 +333,7 @@ } ] } + ] }, { @@ -334,11 +351,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -375,11 +394,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -410,6 +431,7 @@ } ] } + ] }, { @@ -427,11 +449,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -461,7 +485,8 @@ } } ] - }, + } +, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -474,11 +499,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -509,6 +536,7 @@ } ] } + ] } ], diff --git a/postman/PayoutService-v68.json b/postman/PayoutService-v68.json index 9b2f6c8..d0a92e3 100644 --- a/postman/PayoutService-v68.json +++ b/postman/PayoutService-v68.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/storeDetailAndSubmitThirdParty", "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -112,11 +117,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -194,11 +203,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -235,11 +246,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -269,7 +282,8 @@ } } ] - }, + } +, { "name": "/submitThirdParty", "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", @@ -282,11 +296,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -317,6 +333,7 @@ } ] } + ] }, { @@ -334,11 +351,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -375,11 +394,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -410,6 +431,7 @@ } ] } + ] }, { @@ -427,11 +449,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -461,7 +485,8 @@ } } ] - }, + } +, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -474,11 +499,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -509,6 +536,7 @@ } ] } + ] } ], diff --git a/postman/RecurringService-v25.json b/postman/RecurringService-v25.json index 5977ac6..c53834e 100644 --- a/postman/RecurringService-v25.json +++ b/postman/RecurringService-v25.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/listRecurringDetails", "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -105,7 +110,8 @@ } } ] - }, + } +, { "name": "/notifyShopper", "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", @@ -118,11 +124,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -152,7 +160,8 @@ } } ] - }, + } +, { "name": "/scheduleAccountUpdater", "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", @@ -165,11 +174,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -206,11 +217,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -241,6 +254,7 @@ } ] } + ] } ], diff --git a/postman/RecurringService-v30.json b/postman/RecurringService-v30.json index f83909b..0ea0bb7 100644 --- a/postman/RecurringService-v30.json +++ b/postman/RecurringService-v30.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/listRecurringDetails", "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -105,7 +110,8 @@ } } ] - }, + } +, { "name": "/notifyShopper", "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", @@ -118,11 +124,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -152,7 +160,8 @@ } } ] - }, + } +, { "name": "/scheduleAccountUpdater", "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", @@ -165,11 +174,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -206,11 +217,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -241,6 +254,7 @@ } ] } + ] } ], diff --git a/postman/RecurringService-v40.json b/postman/RecurringService-v40.json index ca1359d..416245b 100644 --- a/postman/RecurringService-v40.json +++ b/postman/RecurringService-v40.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/disable", "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -105,7 +110,8 @@ } } ] - }, + } +, { "name": "/listRecurringDetails", "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", @@ -118,11 +124,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -152,7 +160,8 @@ } } ] - }, + } +, { "name": "/notifyShopper", "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", @@ -165,11 +174,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -199,7 +210,8 @@ } } ] - }, + } +, { "name": "/scheduleAccountUpdater", "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", @@ -212,11 +224,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -253,11 +267,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -288,6 +304,7 @@ } ] } + ] } ], diff --git a/postman/RecurringService-v49.json b/postman/RecurringService-v49.json index f506e9f..c84fedf 100644 --- a/postman/RecurringService-v49.json +++ b/postman/RecurringService-v49.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/disable", "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -105,7 +110,8 @@ } } ] - }, + } +, { "name": "/listRecurringDetails", "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", @@ -118,11 +124,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -152,7 +160,8 @@ } } ] - }, + } +, { "name": "/notifyShopper", "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", @@ -165,11 +174,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -199,7 +210,8 @@ } } ] - }, + } +, { "name": "/scheduleAccountUpdater", "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", @@ -212,11 +224,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -253,11 +267,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -288,6 +304,7 @@ } ] } + ] } ], diff --git a/postman/RecurringService-v67.json b/postman/RecurringService-v67.json index c4cc32d..5687a45 100644 --- a/postman/RecurringService-v67.json +++ b/postman/RecurringService-v67.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/disable", "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -105,7 +110,8 @@ } } ] - }, + } +, { "name": "/disablePermit", "description": "Disable a permit that was previously linked to a recurringDetailReference.", @@ -118,11 +124,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -152,7 +160,8 @@ } } ] - }, + } +, { "name": "/listRecurringDetails", "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", @@ -165,11 +174,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -199,7 +210,8 @@ } } ] - }, + } +, { "name": "/notifyShopper", "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", @@ -212,11 +224,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -246,7 +260,8 @@ } } ] - }, + } +, { "name": "/scheduleAccountUpdater", "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", @@ -259,11 +274,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -300,11 +317,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -335,6 +354,7 @@ } ] } + ] } ], diff --git a/postman/RecurringService-v68.json b/postman/RecurringService-v68.json index 6f2545b..79fe1fc 100644 --- a/postman/RecurringService-v68.json +++ b/postman/RecurringService-v68.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/disable", "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -105,7 +110,8 @@ } } ] - }, + } +, { "name": "/disablePermit", "description": "Disable a permit that was previously linked to a recurringDetailReference.", @@ -118,11 +124,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -152,7 +160,8 @@ } } ] - }, + } +, { "name": "/listRecurringDetails", "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", @@ -165,11 +174,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -199,7 +210,8 @@ } } ] - }, + } +, { "name": "/notifyShopper", "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", @@ -212,11 +224,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -246,7 +260,8 @@ } } ] - }, + } +, { "name": "/scheduleAccountUpdater", "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", @@ -259,11 +274,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -300,11 +317,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -335,6 +354,7 @@ } ] } + ] } ], diff --git a/postman/StoredValueService-v46.json b/postman/StoredValueService-v46.json index 82f3612..455d745 100644 --- a/postman/StoredValueService-v46.json +++ b/postman/StoredValueService-v46.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -58,7 +60,8 @@ } } ] - }, + } +, { "name": "/checkBalance", "description": "Checks the balance of the provided payment method.", @@ -71,11 +74,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -105,7 +110,8 @@ } } ] - }, + } +, { "name": "/issue", "description": "Issues a new card of the given payment method.", @@ -118,11 +124,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -152,7 +160,8 @@ } } ] - }, + } +, { "name": "/load", "description": "Loads the payment method with the specified funds.", @@ -165,11 +174,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -199,7 +210,8 @@ } } ] - }, + } +, { "name": "/mergeBalance", "description": "Increases the balance of the paymentmethod by the full amount left on the source paymentmethod", @@ -212,11 +224,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -246,7 +260,8 @@ } } ] - }, + } +, { "name": "/voidTransaction", "description": "Voids the referenced stored value transaction.", @@ -259,11 +274,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -294,6 +311,7 @@ } ] } + ] } ], diff --git a/postman/TestCardService-v1.json b/postman/TestCardService-v1.json index feb0916..d703172 100644 --- a/postman/TestCardService-v1.json +++ b/postman/TestCardService-v1.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -59,6 +61,7 @@ } ] } + ] } ], diff --git a/postman/TfmAPIService-v1.json b/postman/TfmAPIService-v1.json index 2968a41..cde87b5 100644 --- a/postman/TfmAPIService-v1.json +++ b/postman/TfmAPIService-v1.json @@ -24,11 +24,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -65,11 +67,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -106,11 +110,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -140,7 +146,8 @@ } } ] - }, + } +, { "name": "/findTerminal", "description": "Returns the company account, merchant account, or store that a payment terminal is assigned to.", @@ -153,11 +160,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -187,7 +196,8 @@ } } ] - }, + } +, { "name": "/getStoresUnderAccount", "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store.", @@ -200,11 +210,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -241,11 +253,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -275,7 +289,8 @@ } } ] - }, + } +, { "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.", @@ -288,11 +303,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -322,7 +339,8 @@ } } ] - }, + } +, { "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).", @@ -335,11 +353,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -376,11 +396,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -417,11 +439,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -452,6 +476,7 @@ } ] } + ] } ], diff --git a/postman/TransferService-v1.json b/postman/TransferService-v1.json index 38eb474..8a5de36 100644 --- a/postman/TransferService-v1.json +++ b/postman/TransferService-v1.json @@ -24,6 +24,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -49,35 +50,51 @@ "query": [ { "key": "balancePlatform", - "value": "balancePlatform_example" + "value": "balancePlatform_example", + "description": "The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `accountHolderId`.", + "disabled": true }, { "key": "paymentInstrumentId", - "value": "paymentInstrumentId_example" + "value": "paymentInstrumentId_example", + "description": "The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_). To use this parameter, you must also provide a `balanceAccountId`, `accountHolderId`, or `balancePlatform`. The `paymentInstrumentId` must be related to the `balanceAccountId` or `accountHolderId` that you provide.", + "disabled": true }, { "key": "accountHolderId", - "value": "accountHolderId_example" + "value": "accountHolderId_example", + "description": "The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `balancePlatform`. If you provide a `balanceAccountId`, the `accountHolderId` must be related to the `balanceAccountId`.", + "disabled": true }, { "key": "balanceAccountId", - "value": "balanceAccountId_example" + "value": "balanceAccountId_example", + "description": "The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). Required if you don't provide an `accountHolderId` or `balancePlatform`. If you provide an `accountHolderId`, the `balanceAccountId` must be related to the `accountHolderId`.", + "disabled": true }, { "key": "cursor", - "value": "cursor_example" + "value": "cursor_example", + "description": "The `cursor` returned in the links of the previous response.", + "disabled": true }, { "key": "createdSince", - "value": "2013-10-20T19:20:30+01:00" + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include transactions that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "disabled": false }, { "key": "createdUntil", - "value": "2013-10-20T19:20:30+01:00" + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include transactions that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "disabled": false }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -85,7 +102,8 @@ } } ] - }, + } +, { "name": "/transactions/:id", "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns a transaction.", @@ -98,6 +116,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -134,6 +153,7 @@ } ] } + ] }, { @@ -151,16 +171,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -197,16 +220,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -237,6 +263,7 @@ } ] } + ] } ], diff --git a/postman/TransferService-v2.json b/postman/TransferService-v2.json index 04cc05f..6d3538c 100644 --- a/postman/TransferService-v2.json +++ b/postman/TransferService-v2.json @@ -24,6 +24,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -49,35 +50,51 @@ "query": [ { "key": "balancePlatform", - "value": "balancePlatform_example" + "value": "balancePlatform_example", + "description": "The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `accountHolderId`.", + "disabled": true }, { "key": "paymentInstrumentId", - "value": "paymentInstrumentId_example" + "value": "paymentInstrumentId_example", + "description": "The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_). To use this parameter, you must also provide a `balanceAccountId`, `accountHolderId`, or `balancePlatform`. The `paymentInstrumentId` must be related to the `balanceAccountId` or `accountHolderId` that you provide.", + "disabled": true }, { "key": "accountHolderId", - "value": "accountHolderId_example" + "value": "accountHolderId_example", + "description": "The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `balancePlatform`. If you provide a `balanceAccountId`, the `accountHolderId` must be related to the `balanceAccountId`.", + "disabled": true }, { "key": "balanceAccountId", - "value": "balanceAccountId_example" + "value": "balanceAccountId_example", + "description": "The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). Required if you don't provide an `accountHolderId` or `balancePlatform`. If you provide an `accountHolderId`, the `balanceAccountId` must be related to the `accountHolderId`.", + "disabled": true }, { "key": "cursor", - "value": "cursor_example" + "value": "cursor_example", + "description": "The `cursor` returned in the links of the previous response.", + "disabled": true }, { "key": "createdSince", - "value": "2013-10-20T19:20:30+01:00" + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include transactions that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "disabled": false }, { "key": "createdUntil", - "value": "2013-10-20T19:20:30+01:00" + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include transactions that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "disabled": false }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -85,7 +102,8 @@ } } ] - }, + } +, { "name": "/transactions/:id", "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns a transaction.", @@ -98,6 +116,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -134,6 +153,7 @@ } ] } + ] }, { @@ -151,16 +171,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -197,16 +220,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -243,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -283,6 +312,7 @@ } ] } + ] } ], diff --git a/postman/TransferService-v3.json b/postman/TransferService-v3.json index 23e62dc..3b917a8 100644 --- a/postman/TransferService-v3.json +++ b/postman/TransferService-v3.json @@ -24,6 +24,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -49,35 +50,51 @@ "query": [ { "key": "balancePlatform", - "value": "balancePlatform_example" + "value": "balancePlatform_example", + "description": "The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `accountHolderId`.", + "disabled": true }, { "key": "paymentInstrumentId", - "value": "paymentInstrumentId_example" + "value": "paymentInstrumentId_example", + "description": "The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_). To use this parameter, you must also provide a `balanceAccountId`, `accountHolderId`, or `balancePlatform`. The `paymentInstrumentId` must be related to the `balanceAccountId` or `accountHolderId` that you provide.", + "disabled": true }, { "key": "accountHolderId", - "value": "accountHolderId_example" + "value": "accountHolderId_example", + "description": "The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `balancePlatform`. If you provide a `balanceAccountId`, the `accountHolderId` must be related to the `balanceAccountId`.", + "disabled": true }, { "key": "balanceAccountId", - "value": "balanceAccountId_example" + "value": "balanceAccountId_example", + "description": "The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). Required if you don't provide an `accountHolderId` or `balancePlatform`. If you provide an `accountHolderId`, the `balanceAccountId` must be related to the `accountHolderId`.", + "disabled": true }, { "key": "cursor", - "value": "cursor_example" + "value": "cursor_example", + "description": "The `cursor` returned in the links of the previous response.", + "disabled": true }, { "key": "createdSince", - "value": "2013-10-20T19:20:30+01:00" + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include transactions that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "disabled": false }, { "key": "createdUntil", - "value": "2013-10-20T19:20:30+01:00" + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include transactions that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "disabled": false }, { "key": "limit", - "value": "56" + "value": "56", + "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", + "disabled": true } ] }, @@ -85,7 +102,8 @@ } } ] - }, + } +, { "name": "/transactions/:id", "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns a transaction.", @@ -98,6 +116,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -134,6 +153,7 @@ } ] } + ] }, { @@ -151,16 +171,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -197,16 +220,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -243,16 +269,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -289,16 +318,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -335,16 +367,19 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false }, { "key": "WWW-Authenticate", "value": "", + "description": "Header for authenticating through SCA", "disabled": true } ], @@ -374,7 +409,8 @@ } } ] - }, + } +, { "name": "/transfers/:transferId/returns", "description": "Returns previously transferred funds without creating a new `transferId`.", @@ -387,11 +423,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -429,6 +467,7 @@ } ] } + ] }, { @@ -446,6 +485,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -471,7 +511,9 @@ "query": [ { "key": "counterpartyAccountHolderId", - "value": "counterpartyAccountHolderId_example" + "value": "counterpartyAccountHolderId_example", + "description": "The counterparty account holder id.", + "disabled": true } ] }, @@ -479,7 +521,8 @@ } } ] - }, + } +, { "name": "/grants", "description": "Requests the payout of the selected grant offer.", @@ -492,11 +535,13 @@ { "key": "Content-Type", "value": "application/json", + "description": "", "disabled": false }, { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -526,7 +571,8 @@ } } ] - }, + } +, { "name": "/grants/:id", "description": "Returns the details of a capital account specified in the path.", @@ -539,6 +585,7 @@ { "key": "Accept", "value": "application/json", + "description": "", "disabled": false } ], @@ -575,6 +622,7 @@ } ] } + ] } ], diff --git a/postman/TransferService-v4.json b/postman/TransferService-v4.json index 1c1fddd..d8af9eb 100644 --- a/postman/TransferService-v4.json +++ b/postman/TransferService-v4.json @@ -102,7 +102,8 @@ } } ] - }, + } +, { "name": "/transactions/:id", "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns a transaction.", @@ -152,6 +153,7 @@ } ] } + ] }, { @@ -407,7 +409,8 @@ } } ] - }, + } +, { "name": "/transfers/:id/returns", "description": "Returns previously transferred funds without creating a new `transferId`.", @@ -464,6 +467,7 @@ } ] } + ] }, { @@ -517,7 +521,8 @@ } } ] - }, + } +, { "name": "/grants", "description": "Requests the payout of the selected grant offer.", @@ -566,7 +571,8 @@ } } ] - }, + } +, { "name": "/grants/:id", "description": "Returns the details of a capital account specified in the path.", @@ -616,6 +622,7 @@ } ] } + ] } ],