diff --git a/postman/BalanceControlService-v1.json b/postman/BalanceControlService-v1.json index db2c3cc..e61870b 100644 --- a/postman/BalanceControlService-v1.json +++ b/postman/BalanceControlService-v1.json @@ -19,49 +19,101 @@ { "name": "Transfer balances between merchant accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 50000,\n \"currency\" : \"EUR\"\n },\n \"description\" : \"Your description for the transfer\",\n \"fromMerchant\" : \"MerchantAccount_NL\",\n \"toMerchant\" : \"MerchantAccount_DE\",\n \"type\" : \"debit\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceTransfer", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceTransfer" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances: * The source and destination merchant accounts must be under the same company account and legal entity. * The source merchant account must have sufficient funds. * The source and destination merchant accounts must have at least one common processing currency. When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and *not* in parallel. Some requests may not be processed if the requests are sent in parallel. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"value\" : 50000,\n \"currency\" : \"EUR\"\n },\n \"createdAt\" : \"2022-01-24T14:59:11+01:00\",\n \"description\" : \"Your description for the transfer\",\n \"fromMerchant\" : \"MerchantAccount_NL\",\n \"toMerchant\" : \"MerchantAccount_DE\",\n \"type\" : \"debit\",\n \"reference\" : \"Unique reference for the transfer\",\n \"pspReference\" : \"8816080397613514\",\n \"status\" : \"transferred\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 50000,\n \"currency\" : \"EUR\"\n },\n \"description\" : \"Your description for the transfer\",\n \"fromMerchant\" : \"MerchantAccount_NL\",\n \"toMerchant\" : \"MerchantAccount_DE\",\n \"type\" : \"debit\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceTransfer", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceTransfer" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances: * The source and destination merchant accounts must be under the same company account and legal entity. * The source merchant account must have sufficient funds. * The source and destination merchant accounts must have at least one common processing currency. When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and *not* in parallel. Some requests may not be processed if the requests are sent in parallel. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 50000,\n \"currency\" : \"EUR\"\n },\n \"description\" : \"Your description for the transfer\",\n \"fromMerchant\" : \"MerchantAccount_NL\",\n \"toMerchant\" : \"MerchantAccount_DE\",\n \"type\" : \"debit\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceTransfer", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceTransfer" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances: * The source and destination merchant accounts must be under the same company account and legal entity. * The source merchant account must have sufficient funds. * The source and destination merchant accounts must have at least one common processing currency. When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and *not* in parallel. Some requests may not be processed if the requests are sent in parallel. " - } + ] } ] } - ] } ], diff --git a/postman/BalancePlatformService-v1.json b/postman/BalancePlatformService-v1.json index 8ea2aa8..a2105c8 100644 --- a/postman/BalancePlatformService-v1.json +++ b/postman/BalancePlatformService-v1.json @@ -19,178 +19,389 @@ { "name": "Create a legal entity for an individual residing in the Netherlands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE322JV223222D5GG42KN6869\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " - } + ] }, { "name": "Create a legal entity for an individual residing in the US", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE322JV223222D5GGMHPC2FPL\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " - } + ] }, { "name": "Create a legal entity for a Dutch organization", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\",\n \"type\" : \"signatory\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"taxExempt\" : false,\n \"type\" : \"privateCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE322JV223222D5FZ9N74BSGM\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\",\n \"type\" : \"signatory\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\",\n \"type\" : \"signatory\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " - } + ] }, { "name": "Create a legal entity for an organization in the US", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"taxExempt\" : false,\n \"type\" : \"privateCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE322JV223222D5FZ9N74BSGM\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " - } + ] } ] - } -, + }, { "name": "/legalEntities/:id", "description": "Returns a legal entity.", @@ -198,49 +409,50 @@ { "name": "Get a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "description": "Returns a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns a legal entity." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -248,104 +460,221 @@ { "name": "Change a legal entity from an organization to an individual", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"name\" : {\n \"firstName\" : \"Explorer\",\n \"lastName\" : \"Company based in US\"\n },\n \"residentialAddress\" : {\n \"country\" : \"US\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE322JV223222J5HD8HZS2C8B\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Add entity associations to an organization", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE322KH223222F5GV2SL953Z3\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE322KH223222F5GVGNMJ3XC5\",\n \"entityType\" : \"individual\",\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE322KH223222F5GV2SL953Z3\",\n \"name\" : \"Simone Hopper\",\n \"type\" : \"uboThroughControl\"\n } ],\n \"organization\" : {\n \"email\" : \"john.doe@adyen.com\",\n \"phone\" : {\n \"countryCode\" : \"NL\",\n \"number\" : \"646467363\",\n \"type\" : \"mobile\"\n },\n \"description\" : \"FinTech\",\n \"doingBusinessAs\" : \"Adyen BV\",\n \"legalName\" : \"Adyen BV\",\n \"registeredAddress\" : {\n \"city\" : \"AMS\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1234EE\",\n \"stateOrProvince\" : \"NH\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"\",\n \"stockData\" : {\n \"marketIdentifier\" : \"ADYN\",\n \"stockNumber\" : \"NL012345ABC4\",\n \"tickerSymbol\" : \"ADYN.M\"\n },\n \"taxExempt\" : \"false\",\n \"type\" : \"listedPublicCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE322KH223222F5GVGNMJ3XC5\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE322KH223222F5GV2SL953Z3\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE322KH223222F5GV2SL953Z3\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -358,49 +687,50 @@ { "name": "Get a balance platform", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balancePlatforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balancePlatforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance platform." - } - ], - "query": [ - ] - }, - "description": "Returns a balance platform." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balancePlatforms/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balancePlatforms", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance platform." + } + ], + "query": [ + ] + }, + "description": "Returns a balance platform." +} + ,"response": [ + ] } ] - } -, + }, { "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`.", @@ -408,62 +738,63 @@ { "name": "Get all account holders under a balance platform", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balancePlatforms/:id/accountHolders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balancePlatforms", - ":id", - "accountHolders" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance platform." - } - ], - "query": [ - { - "key": "offset", - "value": "56", - "description": "The number of items that you want to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "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`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balancePlatforms/:id/accountHolders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balancePlatforms", + ":id", + "accountHolders" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance platform." + } + ], + "query": [ + { + "key": "offset", + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "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`." +} + ,"response": [ + ] } ] } - ] }, { @@ -476,49 +807,50 @@ { "name": "Create a payment instrument group", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"balancePlatform\" : \"{{YOUR_BALANCE_PLATFORM}}\",\n \"txVariant\" : \"mc\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstrumentGroups", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstrumentGroups" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balancePlatform\" : \"{{YOUR_BALANCE_PLATFORM}}\",\n \"txVariant\" : \"mc\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/paymentInstrumentGroups/:id", "description": "Returns the details of a payment instrument group.", @@ -526,49 +858,50 @@ { "name": "Get a payment instrument group", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstrumentGroups/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstrumentGroups", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument group." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a payment instrument group." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument group." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a payment instrument group." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/paymentInstrumentGroups/:id/transactionRules", "description": "Returns a list of all the transaction rules associated with a payment instrument group.", @@ -576,50 +909,51 @@ { "name": "Get all transaction rules for a payment instrument group", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstrumentGroups/:id/transactionRules", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstrumentGroups", - ":id", - "transactionRules" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument group." - } - ], - "query": [ - ] - }, - "description": "Returns a list of all the transaction rules associated with a payment instrument group." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups/:id/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups", + ":id", + "transactionRules" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument group." + } + ], + "query": [ + ] + }, + "description": "Returns a list of all the transaction rules associated with a payment instrument group." +} + ,"response": [ + ] } ] } - ] }, { @@ -632,49 +966,101 @@ { "name": "Upload a document", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE322KH223222D5GG4C9J83RN\",\n \"type\" : \"legalEntity\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"fileName\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE322KH223222D5GG4C9J83RN\",\n \"type\" : \"legalEntity\"\n },\n \"id\" : \"SE322JV223222F5GV2N9L8GDK\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE322KH223222D5GG4C9J83RN\",\n \"type\" : \"legalEntity\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE322KH223222D5GG4C9J83RN\",\n \"type\" : \"legalEntity\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. " - } + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Deletes a document.", @@ -682,49 +1068,50 @@ { "name": "Delete a document", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document to be deleted." - } - ], - "query": [ - ] - }, - "description": "Deletes a document." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a document." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Returns a document.", @@ -732,49 +1119,50 @@ { "name": "Get a document", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document." - } - ], - "query": [ - ] - }, - "description": "Returns a document." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document." + } + ], + "query": [ + ] + }, + "description": "Returns a document." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Updates a document.", @@ -782,55 +1170,56 @@ { "name": "Update a document", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document to be updated." - } - ], - "query": [ - ] - }, - "description": "Updates a document." - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be updated." + } + ], + "query": [ + ] + }, + "description": "Updates a document." +} + ,"response": [ + ] } ] } - ] }, { @@ -843,49 +1232,50 @@ { "name": "Create an account holder", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). " +} + ,"response": [ + ] } ] - } -, + }, { "name": "/accountHolders/:id", "description": "Returns an account holder.", @@ -893,49 +1283,50 @@ { "name": "Get an account holder", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the account holder." - } - ], - "query": [ - ] - }, - "description": "Returns an account holder." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Returns an account holder." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -943,104 +1334,221 @@ { "name": "Request account holder capability", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\",\n \"capabilities\" : {\n \"receivePayments\" : {\n \"requested\" : true\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balancePlatform\" : \"APIExplorer\",\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"legalEntityId\" : \"LE322JV223222F5GKQZZ9DS99\",\n \"reference\" : \"S.Eller-001\",\n \"capabilities\" : {\n \"receivePayments\" : {\n \"enabled\" : false,\n \"requested\" : true,\n \"allowed\" : false,\n \"verificationStatus\" : \"pending\"\n }\n },\n \"id\" : \"AH3227C223222C5GKR23686TF\",\n \"status\" : \"Active\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\",\n \"capabilities\" : {\n \"receivePayments\" : {\n \"requested\" : true\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\",\n \"capabilities\" : {\n \"receivePayments\" : {\n \"requested\" : true\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the account holder." - } - ], - "query": [ - ] - }, - "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." - } + ] }, { "name": "Deactivate account holder", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"Closed\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balancePlatform\" : \"APIExplorer\",\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"legalEntityId\" : \"LE322JV223222F5GKQZZ9DS99\",\n \"reference\" : \"S.Eller-001\",\n \"id\" : \"AH3227C223222C5GKR23686TF\",\n \"status\" : \"Closed\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"Closed\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"Closed\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the account holder." - } - ], - "query": [ - ] - }, - "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." - } + ] } ] - } -, + }, { "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`.", @@ -1048,62 +1556,63 @@ { "name": "Get all balance accounts of an account holder", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders/:id/balanceAccounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders", - ":id", - "balanceAccounts" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the account holder." - } - ], - "query": [ - { - "key": "offset", - "value": "56", - "description": "The number of items that you want to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "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`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id/balanceAccounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id", + "balanceAccounts" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + { + "key": "offset", + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "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`." +} + ,"response": [ + ] } ] } - ] }, { @@ -1116,178 +1625,389 @@ { "name": "Create a business account in NL", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"NL\",\n \"status\" : \"Active\",\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"bankAccount\" : {\n \"iban\" : \"NL20ADYB2017000035\"\n },\n \"id\" : \"PI322LJ223222B5DJS7CD9LWL\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." - } + ] }, { "name": "Create a business account in the US", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"US\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"US\",\n \"status\" : \"Active\",\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"bankAccount\" : {\n \"accountNumber\" : \"333720756\",\n \"routingNumber\" : \"21000021\",\n \"accountType\" : \"checking\"\n },\n \"id\" : \"PI322LJ223222B5DJS7CD9LWL\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"US\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"US\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." - } + ] }, { "name": "Create a physical card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"card\",\n \"issuingCountryCode\" : \"NL\",\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S.Hopper - Main card\",\n \"status\" : \"Inactive\",\n \"card\" : {\n \"formFactor\" : \"physical\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Sam Hopper\",\n \"deliveryContact\" : {\n \"address\" : {\n \"houseNumberOrName\" : \"64\",\n \"street\" : \"Brannan Street\",\n \"postalCode\" : \"1020CD\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n },\n \"name\" : {\n \"firstName\" : \"Sam\",\n \"lastName\" : \"Hopper\"\n }\n },\n \"configuration\" : {\n \"configurationProfileId\" : \"CP123AB45678C91ABCD2ABCDE\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S. Hopper - Main card\",\n \"issuingCountryCode\" : \"NL\",\n \"status\" : \"Inactive\",\n \"type\" : \"card\",\n \"card\" : {\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Sam Hopper\",\n \"formFactor\" : \"physical\",\n \"number\" : \"************5785\",\n \"bin\" : \"555544\",\n \"expiration\" : {\n \"month\" : \"08\",\n \"year\" : \"2024\"\n },\n \"lastFour\" : \"2765\",\n \"authentication\" : {\n \"password\" : \"******\",\n \"phone\" : {\n \"number\" : \"+123456789\",\n \"type\" : \"mobile\"\n }\n },\n \"deliveryContact\" : {\n \"address\" : {\n \"houseNumberOrName\" : \"64\",\n \"street\" : \"Brannan Street\",\n \"postalCode\" : \"1020CD\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n },\n \"name\" : {\n \"firstName\" : \"Sam\",\n \"lastName\" : \"Hopper\"\n }\n },\n \"configuration\" : {\n \"configurationProfileId\" : \"CP123AB45678C91ABCD2ABCDE\"\n }\n },\n \"id\" : \"PI3227C223222B5BPCMFXD2XG\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"card\",\n \"issuingCountryCode\" : \"NL\",\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S.Hopper - Main card\",\n \"status\" : \"Inactive\",\n \"card\" : {\n \"formFactor\" : \"physical\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Sam Hopper\",\n \"deliveryContact\" : {\n \"address\" : {\n \"houseNumberOrName\" : \"64\",\n \"street\" : \"Brannan Street\",\n \"postalCode\" : \"1020CD\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n },\n \"name\" : {\n \"firstName\" : \"Sam\",\n \"lastName\" : \"Hopper\"\n }\n },\n \"configuration\" : {\n \"configurationProfileId\" : \"CP123AB45678C91ABCD2ABCDE\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"card\",\n \"issuingCountryCode\" : \"NL\",\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S.Hopper - Main card\",\n \"status\" : \"Inactive\",\n \"card\" : {\n \"formFactor\" : \"physical\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Sam Hopper\",\n \"deliveryContact\" : {\n \"address\" : {\n \"houseNumberOrName\" : \"64\",\n \"street\" : \"Brannan Street\",\n \"postalCode\" : \"1020CD\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n },\n \"name\" : {\n \"firstName\" : \"Sam\",\n \"lastName\" : \"Hopper\"\n }\n },\n \"configuration\" : {\n \"configurationProfileId\" : \"CP123AB45678C91ABCD2ABCDE\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." - } + ] }, { "name": "Create a virtual card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"card\",\n \"description\" : \"S. Hopper - Main card\",\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"issuingCountryCode\" : \"NL\",\n \"card\" : {\n \"cardholderName\" : \"Sam Hopper\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"formFactor\" : \"virtual\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S.Hopper - Virtual card\",\n \"issuingCountryCode\" : \"NL\",\n \"status\" : \"Active\",\n \"type\" : \"card\",\n \"card\" : {\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Sam Hopper\",\n \"formFactor\" : \"virtual\",\n \"bin\" : \"555544\",\n \"cvc\" : \"613\",\n \"expiration\" : {\n \"month\" : \"03\",\n \"year\" : \"2025\"\n },\n \"lastFour\" : \"9883\",\n \"number\" : \"5555444411209883\"\n },\n \"id\" : \"PI32272223222B5FR7Z5CFDW4\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"card\",\n \"description\" : \"S. Hopper - Main card\",\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"issuingCountryCode\" : \"NL\",\n \"card\" : {\n \"cardholderName\" : \"Sam Hopper\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"formFactor\" : \"virtual\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"card\",\n \"description\" : \"S. Hopper - Main card\",\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"issuingCountryCode\" : \"NL\",\n \"card\" : {\n \"cardholderName\" : \"Sam Hopper\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"formFactor\" : \"virtual\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." - } + ] } ] - } -, + }, { "name": "/paymentInstruments/:id", "description": "Returns the details of a payment instrument.", @@ -1295,49 +2015,50 @@ { "name": "Get a payment instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a payment instrument." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a payment instrument." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -1345,104 +2066,221 @@ { "name": "Update the balance account linked to a payment instrument", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balanceAccountId\" : \"BA32272223222B5CM82WL892M\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA32272223222B5CM82WL892M\",\n \"description\" : \"S. Hopper - Main card\",\n \"issuingCountryCode\" : \"GB\",\n \"status\" : \"Inactive\",\n \"type\" : \"card\",\n \"card\" : {\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Simon Hopper\",\n \"formFactor\" : \"virtual\",\n \"bin\" : \"555544\",\n \"expiration\" : {\n \"month\" : \"01\",\n \"year\" : \"2024\"\n },\n \"lastFour\" : \"5785\",\n \"number\" : \"************5785\"\n },\n \"id\" : \"PI3227C223222B5CMD278FKGS\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balanceAccountId\" : \"BA32272223222B5CM82WL892M\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"balanceAccountId\" : \"BA32272223222B5CM82WL892M\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Update the status of a payment instrument", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"Suspended\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S. Hopper - Main card\",\n \"issuingCountryCode\" : \"GB\",\n \"status\" : \"Suspended\",\n \"type\" : \"card\",\n \"card\" : {\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Simon Hopper\",\n \"formFactor\" : \"virtual\",\n \"bin\" : \"555544\",\n \"expiration\" : {\n \"month\" : \"01\",\n \"year\" : \"2024\"\n },\n \"lastFour\" : \"5785\",\n \"number\" : \"************5785\"\n },\n \"id\" : \"PI3227C223222B5CMD278FKGS\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"Suspended\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"Suspended\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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", @@ -1450,50 +2288,51 @@ { "name": "Get the PAN of a payment instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id/reveal", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id", - "reveal" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id/reveal", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id", + "reveal" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "name": "/paymentInstruments/:id/transactionRules", "description": "Returns a list of transaction rules associated with a payment instrument.", @@ -1501,50 +2340,51 @@ { "name": "Get all transaction rules for a payment instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id/transactionRules", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id", - "transactionRules" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "description": "Returns a list of transaction rules associated with a payment instrument." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id", + "transactionRules" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "description": "Returns a list of transaction rules associated with a payment instrument." +} + ,"response": [ + ] } ] } - ] }, { @@ -1557,92 +2397,197 @@ { "name": "Validate an IBAN", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"1001001234\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/validateBankAccountIdentification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "validateBankAccountIdentification" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." +} + ,"response": [ + {"name": "Unprocessable Entity - a request validation error.", + "code": 422, + "status": "Unprocessable Entity", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"https://docs.adyen.com/errors/validation\",\n \"title\" : \"Invalid bank account identification details provided\",\n \"status\" : 422,\n \"invalidFields\" : [ {\n \"name\" : \"iban\",\n \"message\" : \"Invalid IBAN.\"\n } ],\n \"errorCode\" : \"33_01\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"1001001234\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/validateBankAccountIdentification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "validateBankAccountIdentification" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"1001001234\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/validateBankAccountIdentification", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "validateBankAccountIdentification" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." - } + ] }, { "name": "Validate a US bank account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"12345JHDhjkf67890\",\n \"routingNumber\" : \"121000cxhgjhzxg248\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/validateBankAccountIdentification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "validateBankAccountIdentification" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." +} + ,"response": [ + {"name": "Unprocessable Entity - a request validation error.", + "code": 422, + "status": "Unprocessable Entity", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"https://docs.adyen.com/errors/validation\",\n \"title\" : \"Invalid bank account identification details provided\",\n \"status\" : 422,\n \"invalidFields\" : [ {\n \"name\" : \"accountNumber\",\n \"message\" : \"Invalid account number.\"\n }, {\n \"name\" : \"routingNumber\",\n \"message\" : \"Invalid routing number.\"\n } ],\n \"errorCode\" : \"33_01\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"12345JHDhjkf67890\",\n \"routingNumber\" : \"121000cxhgjhzxg248\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/validateBankAccountIdentification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "validateBankAccountIdentification" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"12345JHDhjkf67890\",\n \"routingNumber\" : \"121000cxhgjhzxg248\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/validateBankAccountIdentification", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "validateBankAccountIdentification" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." - } + ] } ] } - ] }, { @@ -1655,92 +2600,197 @@ { "name": "Add a EUR bank account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE322KH223222D5GG4C9J83RN\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\"\n },\n \"legalEntityId\" : \"LE322KH223222D5GG4C9J83RN\",\n \"type\" : \"bankAccount\",\n \"id\" : \"SE576BH223222F5GJVKHH6BDT\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE322KH223222D5GG4C9J83RN\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityId\" : \"LE322KH223222D5GG4C9J83RN\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." - } + ] }, { "name": "Add a USD bank account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE322JV223222D5GGMHPC2FPL\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"accountNumber\" : \"0000000123\",\n \"branchCode\" : \"121202211\",\n \"accountType\" : \"checking\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"accountNumber\" : \"0000000123\",\n \"accountType\" : \"checking\",\n \"branchCode\" : \"121202211\",\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\"\n },\n \"legalEntityId\" : \"LE322JV223222D5GGMHPC2FPL\",\n \"type\" : \"bankAccount\",\n \"id\" : \"SE322JV223222F5GJVKHH8DTC\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE322JV223222D5GGMHPC2FPL\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"accountNumber\" : \"0000000123\",\n \"branchCode\" : \"121202211\",\n \"accountType\" : \"checking\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityId\" : \"LE322JV223222D5GGMHPC2FPL\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"accountNumber\" : \"0000000123\",\n \"branchCode\" : \"121202211\",\n \"accountType\" : \"checking\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." - } + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Deletes a transfer instrument.", @@ -1748,49 +2798,50 @@ { "name": "Delete a transfer instrument", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument to be deleted." - } - ], - "query": [ - ] - }, - "description": "Deletes a transfer instrument." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a transfer instrument." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Returns the details of a transfer instrument.", @@ -1798,49 +2849,50 @@ { "name": "Get a transfer instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a transfer instrument." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a transfer instrument." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Updates a transfer instrument.", @@ -1848,55 +2900,56 @@ { "name": "Update a transfer instrument", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bankAccount\": \"\",\n \"legalEntityId\": \"\",\n \"type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument." - } - ], - "query": [ - ] - }, - "description": "Updates a transfer instrument." - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bankAccount\": \"\",\n \"legalEntityId\": \"\",\n \"type\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a transfer instrument." +} + ,"response": [ + ] } ] } - ] }, { @@ -1909,49 +2962,50 @@ { "name": "Create a balance account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountHolderId\" : \"AH32272223222C5GXTD343TKP\",\n \"description\" : \"S.Hopper - Main balance account\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a balance account that holds the funds of the associated account holder." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountHolderId\" : \"AH32272223222C5GXTD343TKP\",\n \"description\" : \"S.Hopper - Main balance account\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a balance account that holds the funds of the associated account holder." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/balanceAccounts/:id", "description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.", @@ -1959,49 +3013,50 @@ { "name": "Get a balance account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - ] - }, - "description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/balanceAccounts/:id", "description": "Updates a balance account.", @@ -2009,55 +3064,56 @@ { "name": "Update a balance account", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountHolderId\": \"\",\n \"defaultCurrencyCode\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"sweepConfigurations\": \"\",\n \"timeZone\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - ] - }, - "description": "Updates a balance account." - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountHolderId\": \"\",\n \"defaultCurrencyCode\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"sweepConfigurations\": \"\",\n \"timeZone\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "description": "Updates a balance account." +} + ,"response": [ + ] } ] - } -, + }, { "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`.", @@ -2065,62 +3121,63 @@ { "name": "Get all payment instruments for a balance account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:id/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":id", - "paymentInstruments" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - { - "key": "offset", - "value": "56", - "description": "The number of items that you want to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "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`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:id/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":id", + "paymentInstruments" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + { + "key": "offset", + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "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`." +} + ,"response": [ + ] } ] } - ] }, { @@ -2133,49 +3190,50 @@ { "name": "Create a transaction rule", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Allow transactions only from NL\",\n \"reference\" : \"{{$guid}}_1738A\",\n \"paymentInstrumentId\" : \"PI32272223222B5FN64HK3KLM\",\n \"type\" : \"allowList\",\n \"countries\" : [ \"NL\" ],\n \"status\" : \"active\",\n \"interval\" : {\n \"type\" : \"perTransaction\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Allow transactions only from NL\",\n \"reference\" : \"{{$guid}}_1738A\",\n \"paymentInstrumentId\" : \"PI32272223222B5FN64HK3KLM\",\n \"type\" : \"allowList\",\n \"countries\" : [ \"NL\" ],\n \"status\" : \"active\",\n \"interval\" : {\n \"type\" : \"perTransaction\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transactionRules/:transactionRuleId", "description": "Deletes a transaction rule.", @@ -2183,49 +3241,50 @@ { "name": "Delete a transaction rule", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules", - ":transactionRuleId" - ], - "variable": [ - { - "key": "transactionRuleId", - "value": "", - "description": "The unique identifier of the transaction rule." - } - ], - "query": [ - ] - }, - "description": "Deletes a transaction rule." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + ":transactionRuleId" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "description": "Deletes a transaction rule." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transactionRules/:transactionRuleId", "description": "Returns the details of a transaction rule.", @@ -2233,49 +3292,50 @@ { "name": "Get a transaction rule", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules", - ":transactionRuleId" - ], - "variable": [ - { - "key": "transactionRuleId", - "value": "", - "description": "The unique identifier of the transaction rule." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a transaction rule." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + ":transactionRuleId" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a transaction rule." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -2283,55 +3343,113 @@ { "name": "Update the status of transaction rule", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"inactive\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + ":transactionRuleId" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Allow 5 transactions per month\",\n \"interval\" : {\n \"type\" : \"monthly\"\n },\n \"maxTransactions\" : 5,\n \"paymentInstrumentId\" : \"PI3227C223222B59KGTXP884R\",\n \"reference\" : \"myRule12345\",\n \"startDate\" : \"2021-01-21T12:46:35\",\n \"status\" : \"inactive\",\n \"type\" : \"velocity\",\n \"id\" : \"TR3227C223222B5B85CDV4DRS\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"inactive\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + ":transactionRuleId" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"inactive\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules", - ":transactionRuleId" - ], - "variable": [ - { - "key": "transactionRuleId", - "value": "", - "description": "The unique identifier of the transaction rule." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] } ], diff --git a/postman/BalancePlatformService-v2.json b/postman/BalancePlatformService-v2.json index d9d5909..941ea5a 100644 --- a/postman/BalancePlatformService-v2.json +++ b/postman/BalancePlatformService-v2.json @@ -19,49 +19,50 @@ { "name": "Get a balance platform", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balancePlatforms/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balancePlatforms", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance platform." - } - ], - "query": [ - ] - }, - "description": "Returns a balance platform." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balancePlatforms/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balancePlatforms", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance platform." + } + ], + "query": [ + ] + }, + "description": "Returns a balance platform." +} + ,"response": [ + ] } ] - } -, + }, { "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`.", @@ -69,62 +70,63 @@ { "name": "Get all account holders under a balance platform", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balancePlatforms/:id/accountHolders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balancePlatforms", - ":id", - "accountHolders" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance platform." - } - ], - "query": [ - { - "key": "offset", - "value": "56", - "description": "The number of items that you want to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "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`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balancePlatforms/:id/accountHolders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balancePlatforms", + ":id", + "accountHolders" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance platform." + } + ], + "query": [ + { + "key": "offset", + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "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`." +} + ,"response": [ + ] } ] } - ] }, { @@ -137,49 +139,50 @@ { "name": "Get all available grant offers", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grantOffers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grantOffers" - ], - "variable": [ - ], - "query": [ - { - "key": "accountHolderId", - "value": "accountHolderId_example", - "description": "The unique identifier of the grant account.", - "disabled": false - } - ] - }, - "description": "Returns a list of all [grant offers](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-offers) available for `accountHolderId` specified as a query parameter." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grantOffers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grantOffers" + ], + "variable": [ + ], + "query": [ + { + "key": "accountHolderId", + "value": "accountHolderId_example", + "description": "The unique identifier of the grant account.", + "disabled": false + } + ] + }, + "description": "Returns a list of all [grant offers](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-offers) available for `accountHolderId` specified as a query parameter." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/grantOffers/:grantOfferId", "description": "Returns the details of a single grant offer.", @@ -187,49 +190,50 @@ { "name": "Get a grant offer", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grantOffers/:grantOfferId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grantOffers", - ":grantOfferId" - ], - "variable": [ - { - "key": "grantOfferId", - "value": "", - "description": "The unique identifier of the grant offer." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a single grant offer." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grantOffers/:grantOfferId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grantOffers", + ":grantOfferId" + ], + "variable": [ + { + "key": "grantOfferId", + "value": "", + "description": "The unique identifier of the grant offer." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a single grant offer." +} + ,"response": [ + ] } ] } - ] }, { @@ -242,49 +246,50 @@ { "name": "Get a network token", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/networkTokens/:networkTokenId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "networkTokens", - ":networkTokenId" - ], - "variable": [ - { - "key": "networkTokenId", - "value": "", - "description": "The unique identifier of the network token." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a network token." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/networkTokens/:networkTokenId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "networkTokens", + ":networkTokenId" + ], + "variable": [ + { + "key": "networkTokenId", + "value": "", + "description": "The unique identifier of the network token." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a network token." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/networkTokens/:networkTokenId", "description": "Updates the status of the network token.", @@ -292,55 +297,56 @@ { "name": "Update a network token", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/networkTokens/:networkTokenId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "networkTokens", - ":networkTokenId" - ], - "variable": [ - { - "key": "networkTokenId", - "value": "", - "description": "The unique identifier of the network token." - } - ], - "query": [ - ] - }, - "description": "Updates the status of the network token." - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/networkTokens/:networkTokenId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "networkTokens", + ":networkTokenId" + ], + "variable": [ + { + "key": "networkTokenId", + "value": "", + "description": "The unique identifier of the network token." + } + ], + "query": [ + ] + }, + "description": "Updates the status of the network token." +} + ,"response": [ + ] } ] } - ] }, { @@ -353,49 +359,101 @@ { "name": "Create an account holder", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balancePlatform\" : \"YOUR_BALANCE_PLATFORM\",\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\",\n \"reference\" : \"S.Eller-001\",\n \"capabilities\" : {\n \"receiveFromPlatformPayments\" : {\n \"enabled\" : true,\n \"requested\" : true,\n \"allowed\" : false,\n \"verificationStatus\" : \"pending\"\n },\n \"receiveFromBalanceAccount\" : {\n \"enabled\" : true,\n \"requested\" : true,\n \"allowed\" : false,\n \"verificationStatus\" : \"pending\"\n },\n \"sendToBalanceAccount\" : {\n \"enabled\" : true,\n \"requested\" : true,\n \"allowed\" : false,\n \"verificationStatus\" : \"pending\"\n },\n \"sendToTransferInstrument\" : {\n \"enabled\" : true,\n \"requested\" : true,\n \"allowed\" : false,\n \"requestedSettings\" : {\n \"interval\" : \"daily\",\n \"maxAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 0\n }\n },\n \"verificationStatus\" : \"pending\"\n }\n },\n \"id\" : \"AH3227C223222H5J4DCLW9VBV\",\n \"status\" : \"active\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"legalEntityId\" : \"LE322JV223222D5GG42KN6869\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). " - } + ] } ] - } -, + }, { "name": "/accountHolders/:id", "description": "Returns an account holder.", @@ -403,49 +461,50 @@ { "name": "Get an account holder", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the account holder." - } - ], - "query": [ - ] - }, - "description": "Returns an account holder." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Returns an account holder." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -453,104 +512,221 @@ { "name": "Request account holder capability", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"capabilities\" : {\n \"receivePayments\" : {\n \"requested\" : true\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balancePlatform\" : \"YOUR_BALANCE_PLATFORM\",\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"legalEntityId\" : \"LE322JV223222F5GKQZZ9DS99\",\n \"reference\" : \"S.Eller-001\",\n \"capabilities\" : {\n \"receivePayments\" : {\n \"enabled\" : false,\n \"requested\" : true,\n \"allowed\" : false,\n \"verificationStatus\" : \"pending\"\n }\n },\n \"id\" : \"AH3227C223222C5GKR23686TF\",\n \"status\" : \"active\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"capabilities\" : {\n \"receivePayments\" : {\n \"requested\" : true\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"reference\" : \"S.Eller-001\",\n \"capabilities\" : {\n \"receivePayments\" : {\n \"requested\" : true\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the account holder." - } - ], - "query": [ - ] - }, - "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." - } + ] }, { "name": "Deactivate an account holder", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"closed\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balancePlatform\" : \"YOUR_BALANCE_PLATFORM\",\n \"description\" : \"Liable account holder used for international payments and payouts\",\n \"legalEntityId\" : \"LE322JV223222F5GKQZZ9DS99\",\n \"reference\" : \"S.Eller-001\",\n \"id\" : \"AH3227C223222C5GKR23686TF\",\n \"status\" : \"closed\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"closed\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"closed\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the account holder." - } - ], - "query": [ - ] - }, - "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." - } + ] } ] - } -, + }, { "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`.", @@ -558,62 +734,63 @@ { "name": "Get all balance accounts of an account holder", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders/:id/balanceAccounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders", - ":id", - "balanceAccounts" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the account holder." - } - ], - "query": [ - { - "key": "offset", - "value": "56", - "description": "The number of items that you want to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "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`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id/balanceAccounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id", + "balanceAccounts" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + { + "key": "offset", + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "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`." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -621,62 +798,63 @@ { "name": "Get a tax form", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/accountHolders/:id/taxForms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "accountHolders", - ":id", - "taxForms" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the account holder." - } - ], - "query": [ - { - "key": "formType", - "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", - "description": "The tax year in YYYY format for the tax form you want to retrieve", - "disabled": false - } - ] - }, - "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/)." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/:id/taxForms", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + ":id", + "taxForms" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + { + "key": "formType", + "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", + "description": "The tax year in YYYY format for the tax form you want to retrieve", + "disabled": false + } + ] + }, + "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/)." +} + ,"response": [ + ] } ] } - ] }, { @@ -689,178 +867,389 @@ { "name": "Create a business account in NL", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"NL\",\n \"status\" : \"active\",\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"bankAccount\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL20ADYB2017000035\"\n },\n \"id\" : \"PI322LJ223222B5DJS7CD9LWL\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." - } + ] }, { "name": "Create a business account in the US", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"US\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"US\",\n \"status\" : \"active\",\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"bankAccount\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"333720756\",\n \"routingNumber\" : \"210000210\",\n \"accountType\" : \"checking\"\n },\n \"id\" : \"PI322LJ223222B5DJS7CD9LWL\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"US\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"bankAccount\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"balanceAccountId\" : \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\" : \"US\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." - } + ] }, { "name": "Create a physical card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"card\",\n \"issuingCountryCode\" : \"NL\",\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S.Hopper - Main card\",\n \"status\" : \"inactive\",\n \"card\" : {\n \"formFactor\" : \"physical\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Sam Hopper\",\n \"deliveryContact\" : {\n \"address\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"stateOrProvince\" : \"NH\",\n \"line1\" : \"Brannan Street\",\n \"line2\" : \"274\",\n \"postalCode\" : \"1020CD\"\n },\n \"name\" : {\n \"firstName\" : \"Sam\",\n \"lastName\" : \"Hopper\"\n }\n },\n \"configuration\" : {\n \"configurationProfileId\" : \"CP123AB45678C91ABCD2ABCDE\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S. Hopper - Main card\",\n \"issuingCountryCode\" : \"NL\",\n \"status\" : \"inactive\",\n \"type\" : \"card\",\n \"card\" : {\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Sam Hopper\",\n \"formFactor\" : \"physical\",\n \"number\" : \"************5785\",\n \"bin\" : \"555544\",\n \"expiration\" : {\n \"month\" : \"08\",\n \"year\" : \"2024\"\n },\n \"lastFour\" : \"2765\",\n \"authentication\" : {\n \"password\" : \"******\",\n \"phone\" : {\n \"number\" : \"+123456789\",\n \"type\" : \"mobile\"\n }\n },\n \"deliveryContact\" : {\n \"address\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"stateOrProvince\" : \"NH\",\n \"line1\" : \"Brannan Street\",\n \"line2\" : \"274\",\n \"postalCode\" : \"1020CD\"\n },\n \"name\" : {\n \"firstName\" : \"Sam\",\n \"lastName\" : \"Hopper\"\n }\n },\n \"configuration\" : {\n \"configurationProfileId\" : \"CP123AB45678C91ABCD2ABCDE\"\n }\n },\n \"id\" : \"PI3227C223222B5BPCMFXD2XG\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"card\",\n \"issuingCountryCode\" : \"NL\",\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S.Hopper - Main card\",\n \"status\" : \"inactive\",\n \"card\" : {\n \"formFactor\" : \"physical\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Sam Hopper\",\n \"deliveryContact\" : {\n \"address\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"stateOrProvince\" : \"NH\",\n \"line1\" : \"Brannan Street\",\n \"line2\" : \"274\",\n \"postalCode\" : \"1020CD\"\n },\n \"name\" : {\n \"firstName\" : \"Sam\",\n \"lastName\" : \"Hopper\"\n }\n },\n \"configuration\" : {\n \"configurationProfileId\" : \"CP123AB45678C91ABCD2ABCDE\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"card\",\n \"issuingCountryCode\" : \"NL\",\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S.Hopper - Main card\",\n \"status\" : \"inactive\",\n \"card\" : {\n \"formFactor\" : \"physical\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Sam Hopper\",\n \"deliveryContact\" : {\n \"address\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"stateOrProvince\" : \"NH\",\n \"line1\" : \"Brannan Street\",\n \"line2\" : \"274\",\n \"postalCode\" : \"1020CD\"\n },\n \"name\" : {\n \"firstName\" : \"Sam\",\n \"lastName\" : \"Hopper\"\n }\n },\n \"configuration\" : {\n \"configurationProfileId\" : \"CP123AB45678C91ABCD2ABCDE\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." - } + ] }, { "name": "Create a virtual card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"card\",\n \"description\" : \"My test card\",\n \"balanceAccountId\" : \"BA3227C223222B5FG88S28BGN\",\n \"issuingCountryCode\" : \"NL\",\n \"card\" : {\n \"cardholderName\" : \"Simon Hopper\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"formFactor\" : \"virtual\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA3227C223222B5FG88S28BGN\",\n \"description\" : \"My test card\",\n \"issuingCountryCode\" : \"NL\",\n \"status\" : \"active\",\n \"type\" : \"card\",\n \"card\" : {\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Simon Hopper\",\n \"formFactor\" : \"virtual\",\n \"bin\" : \"555544\",\n \"cvc\" : \"136\",\n \"expiration\" : {\n \"month\" : \"11\",\n \"year\" : \"2025\"\n },\n \"lastFour\" : \"3703\",\n \"number\" : \"5555444411213703\"\n },\n \"id\" : \"PI32272223222C5GXTDWH3TTN\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"card\",\n \"description\" : \"My test card\",\n \"balanceAccountId\" : \"BA3227C223222B5FG88S28BGN\",\n \"issuingCountryCode\" : \"NL\",\n \"card\" : {\n \"cardholderName\" : \"Simon Hopper\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"formFactor\" : \"virtual\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"card\",\n \"description\" : \"My test card\",\n \"balanceAccountId\" : \"BA3227C223222B5FG88S28BGN\",\n \"issuingCountryCode\" : \"NL\",\n \"card\" : {\n \"cardholderName\" : \"Simon Hopper\",\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"formFactor\" : \"virtual\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." - } + ] } ] - } -, + }, { "name": "/paymentInstruments/:id", "description": "Returns the details of a payment instrument.", @@ -868,49 +1257,50 @@ { "name": "Get a payment instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a payment instrument." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a payment instrument." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -918,104 +1308,221 @@ { "name": "Update the balance account linked to a payment instrument", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balanceAccountId\" : \"BA32272223222B5CM82WL892M\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA32272223222B5CM82WL892M\",\n \"description\" : \"S. Hopper - Main card\",\n \"issuingCountryCode\" : \"GB\",\n \"status\" : \"inactive\",\n \"type\" : \"card\",\n \"card\" : {\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Simon Hopper\",\n \"formFactor\" : \"virtual\",\n \"bin\" : \"555544\",\n \"expiration\" : {\n \"month\" : \"01\",\n \"year\" : \"2024\"\n },\n \"lastFour\" : \"5785\",\n \"number\" : \"************5785\"\n },\n \"id\" : \"PI3227C223222B5CMD278FKGS\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balanceAccountId\" : \"BA32272223222B5CM82WL892M\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"balanceAccountId\" : \"BA32272223222B5CM82WL892M\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Update the status of a payment instrument", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"suspended\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balanceAccountId\" : \"BA32272223222B59CZ3T52DKZ\",\n \"description\" : \"S. Hopper - Main card\",\n \"issuingCountryCode\" : \"GB\",\n \"status\" : \"suspended\",\n \"type\" : \"card\",\n \"card\" : {\n \"brand\" : \"mc\",\n \"brandVariant\" : \"mcdebit\",\n \"cardholderName\" : \"Simon Hopper\",\n \"formFactor\" : \"virtual\",\n \"bin\" : \"555544\",\n \"expiration\" : {\n \"month\" : \"01\",\n \"year\" : \"2024\"\n },\n \"lastFour\" : \"5785\",\n \"number\" : \"************5785\"\n },\n \"id\" : \"PI3227C223222B5CMD278FKGS\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"suspended\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"suspended\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "name": "/paymentInstruments/:id/networkTokens", "description": "List the network tokens connected to a payment instrument.", @@ -1023,50 +1530,51 @@ { "name": "List network tokens", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id/networkTokens", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id", - "networkTokens" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "description": "List the network tokens connected to a payment instrument." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id/networkTokens", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id", + "networkTokens" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "description": "List the network tokens connected to a payment instrument." +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -1074,50 +1582,51 @@ { "name": "Get the PAN of a payment instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id/reveal", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id", - "reveal" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id/reveal", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id", + "reveal" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "name": "/paymentInstruments/:id/transactionRules", "description": "Returns a list of transaction rules associated with a payment instrument.", @@ -1125,50 +1634,51 @@ { "name": "Get all transaction rules for a payment instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/:id/transactionRules", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - ":id", - "transactionRules" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument." - } - ], - "query": [ - ] - }, - "description": "Returns a list of transaction rules associated with a payment instrument." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/:id/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + ":id", + "transactionRules" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "description": "Returns a list of transaction rules associated with a payment instrument." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/paymentInstruments/reveal", "description": "Returns the encrypted data of a specified payment instrument. These data include: - The primary account number (PAN) - The card verification code (CVC) - The expiry date You can decrypt the data to reveal it in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PAN Reveal Webservice role", @@ -1176,50 +1686,51 @@ { "name": "Reveal the data of a payment instrument", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"encryptedKey\": \"\",\n \"paymentInstrumentId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstruments/reveal", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstruments", - "reveal" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns the encrypted data of a specified payment instrument. These data include: - The primary account number (PAN) - The card verification code (CVC) - The expiry date You can decrypt the data to reveal it in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PAN Reveal Webservice role" - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"encryptedKey\": \"\",\n \"paymentInstrumentId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/reveal", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + "reveal" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns the encrypted data of a specified payment instrument. These data include: - The primary account number (PAN) - The card verification code (CVC) - The expiry date You can decrypt the data to reveal it in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PAN Reveal Webservice role" +} + ,"response": [ + ] } ] } - ] }, { @@ -1232,49 +1743,50 @@ { "name": "Get a grant account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grantAccounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grantAccounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the grant account." - } - ], - "query": [ - ] - }, - "description": "Returns the details of the [grant account](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-account)." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grantAccounts/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grantAccounts", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the grant account." + } + ], + "query": [ + ] + }, + "description": "Returns the details of the [grant account](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-account)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1287,49 +1799,101 @@ { "name": "Create a balance account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountHolderId\" : \"AH32272223222C5GXTD343TKP\",\n \"description\" : \"S.Hopper - Main balance account\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a balance account that holds the funds of the associated account holder." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"accountHolderId\" : \"AH32272223222C5GXTD343TKP\",\n \"defaultCurrencyCode\" : \"EUR\",\n \"description\" : \"S.Hopper - Main balance account\",\n \"timeZone\" : \"Europe/Amsterdam\",\n \"balances\" : [ {\n \"available\" : 0,\n \"balance\" : 0,\n \"currency\" : \"EUR\",\n \"reserved\" : 0\n } ],\n \"id\" : \"BA3227C223222H5J4DCGQ9V9L\",\n \"status\" : \"active\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountHolderId\" : \"AH32272223222C5GXTD343TKP\",\n \"description\" : \"S.Hopper - Main balance account\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a balance account that holds the funds of the associated account holder." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountHolderId\" : \"AH32272223222C5GXTD343TKP\",\n \"description\" : \"S.Hopper - Main balance account\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a balance account that holds the funds of the associated account holder." - } + ] } ] - } -, + }, { "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`.", @@ -1337,62 +1901,63 @@ { "name": "Get all sweeps for a balance account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":balanceAccountId", - "sweeps" - ], - "variable": [ - { - "key": "balanceAccountId", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - { - "key": "offset", - "value": "56", - "description": "The number of items that you want to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "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`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + { + "key": "offset", + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "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`." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -1400,156 +1965,335 @@ { "name": "Create a sweep to pull funds in to a balance account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"counterparty\" : {\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"schedule\" : {\n \"type\" : \"balance\"\n },\n \"type\" : \"pull\",\n \"status\" : \"active\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"SWPC4227C224555B5FTD2NT2JV4WN5\",\n \"counterparty\" : {\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"schedule\" : {\n \"type\" : \"balance\"\n },\n \"type\" : \"pull\",\n \"status\" : \"active\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"counterparty\" : {\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"schedule\" : {\n \"type\" : \"balance\"\n },\n \"type\" : \"pull\",\n \"status\" : \"active\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"counterparty\" : {\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"schedule\" : {\n \"type\" : \"balance\"\n },\n \"type\" : \"pull\",\n \"status\" : \"active\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":balanceAccountId", - "sweeps" - ], - "variable": [ - { - "key": "balanceAccountId", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Create a sweep to push funds out of a balance account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32278887611B5FTD2KR6TJD\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"schedule\" : {\n \"type\" : \"weekly\"\n },\n \"type\" : \"push\",\n \"status\" : \"active\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"SWPC4227C224555B5FTD2NT2JV4WN5\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32278887611B5FTD2KR6TJD\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"schedule\" : {\n \"type\" : \"weekly\"\n },\n \"type\" : \"push\",\n \"status\" : \"active\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32278887611B5FTD2KR6TJD\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"schedule\" : {\n \"type\" : \"weekly\"\n },\n \"type\" : \"push\",\n \"status\" : \"active\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32278887611B5FTD2KR6TJD\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"schedule\" : {\n \"type\" : \"weekly\"\n },\n \"type\" : \"push\",\n \"status\" : \"active\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":balanceAccountId", - "sweeps" - ], - "variable": [ - { - "key": "balanceAccountId", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Create a sweep to push funds out of a balance account with set priorities", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE322JV223222J5HGLCGF2WDV\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"priorities\" : [ \"fast\", \"instant\" ],\n \"category\" : \"bank\",\n \"schedule\" : {\n \"type\" : \"weekly\"\n },\n \"type\" : \"push\",\n \"status\" : \"active\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"SWPC4227C224555B5FTD2NT2JV4WN9\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE322JV223222J5HGLCGF2WDV\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"priorities\" : [ \"fast\", \"instant\" ],\n \"category\" : \"bank\",\n \"schedule\" : {\n \"type\" : \"weekly\"\n },\n \"type\" : \"push\",\n \"status\" : \"active\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE322JV223222J5HGLCGF2WDV\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"priorities\" : [ \"fast\", \"instant\" ],\n \"category\" : \"bank\",\n \"schedule\" : {\n \"type\" : \"weekly\"\n },\n \"type\" : \"push\",\n \"status\" : \"active\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE322JV223222J5HGLCGF2WDV\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"priorities\" : [ \"fast\", \"instant\" ],\n \"category\" : \"bank\",\n \"schedule\" : {\n \"type\" : \"weekly\"\n },\n \"type\" : \"push\",\n \"status\" : \"active\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":balanceAccountId", - "sweeps" - ], - "variable": [ - { - "key": "balanceAccountId", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "name": "/balanceAccounts/:balanceAccountId/sweeps/:sweepId", "description": "Deletes a sweep for a balance account.", @@ -1557,56 +2301,57 @@ { "name": "Delete a sweep", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":balanceAccountId", - "sweeps", - ":sweepId" - ], - "variable": [ - { - "key": "balanceAccountId", - "value": "", - "description": "The unique identifier of the balance account." - }, - { - "key": "sweepId", - "value": "", - "description": "The unique identifier of the sweep." - } - ], - "query": [ - ] - }, - "description": "Deletes a sweep for a balance account." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps", + ":sweepId" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + }, + { + "key": "sweepId", + "value": "", + "description": "The unique identifier of the sweep." + } + ], + "query": [ + ] + }, + "description": "Deletes a sweep for a balance account." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/balanceAccounts/:balanceAccountId/sweeps/:sweepId", "description": "Returns a sweep.", @@ -1614,56 +2359,57 @@ { "name": "Get a sweep", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":balanceAccountId", - "sweeps", - ":sweepId" - ], - "variable": [ - { - "key": "balanceAccountId", - "value": "", - "description": "The unique identifier of the balance account." - }, - { - "key": "sweepId", - "value": "", - "description": "The unique identifier of the sweep." - } - ], - "query": [ - ] - }, - "description": "Returns a sweep." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps", + ":sweepId" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + }, + { + "key": "sweepId", + "value": "", + "description": "The unique identifier of the sweep." + } + ], + "query": [ + ] + }, + "description": "Returns a sweep." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -1671,62 +2417,127 @@ { "name": "Update the status of a sweep", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"inactive\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps", + ":sweepId" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + }, + { + "key": "sweepId", + "value": "", + "description": "The unique identifier of the sweep." + } + ], + "query": [ + ] + }, + "description": "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"SWPC4227C224555B5FTD2NT2JV4WN5\",\n \"counterparty\" : {\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\"\n },\n \"triggerAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n },\n \"currency\" : \"EUR\",\n \"schedule\" : {\n \"type\" : \"balance\"\n },\n \"type\" : \"pull\",\n \"status\" : \"inactive\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"inactive\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":balanceAccountId", + "sweeps", + ":sweepId" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + }, + { + "key": "sweepId", + "value": "", + "description": "The unique identifier of the sweep." + } + ], + "query": [ + ] + }, + "description": "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"inactive\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":balanceAccountId", - "sweeps", - ":sweepId" - ], - "variable": [ - { - "key": "balanceAccountId", - "value": "", - "description": "The unique identifier of the balance account." - }, - { - "key": "sweepId", - "value": "", - "description": "The unique identifier of the sweep." - } - ], - "query": [ - ] - }, - "description": "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged." - } + ] } ] - } -, + }, { "name": "/balanceAccounts/:id", "description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.", @@ -1734,49 +2545,50 @@ { "name": "Get a balance account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - ] - }, - "description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/balanceAccounts/:id", "description": "Updates a balance account.", @@ -1784,55 +2596,113 @@ { "name": "Update the time zone of a balance account", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\" : \"Europe/Amsterdam\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "description": "Updates a balance account." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"accountHolderId\" : \"AH32272223222B5GFSNVGFFM7\",\n \"defaultCurrencyCode\" : \"EUR\",\n \"timeZone\" : \"Europe/Amsterdam\",\n \"balances\" : [ {\n \"available\" : 0,\n \"balance\" : 0,\n \"currency\" : \"EUR\",\n \"reserved\" : 0\n } ],\n \"id\" : \"BA32272223222B59K6ZXHBFN6\",\n \"status\" : \"active\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\" : \"Europe/Amsterdam\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "description": "Updates a balance account." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"timeZone\" : \"Europe/Amsterdam\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - ] - }, - "description": "Updates a balance account." - } + ] } ] - } -, + }, { "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 which are in active status and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6&status=active`.", @@ -1840,68 +2710,69 @@ { "name": "Get payment instruments linked to a balance account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/balanceAccounts/:id/paymentInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "balanceAccounts", - ":id", - "paymentInstruments" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the balance account." - } - ], - "query": [ - { - "key": "offset", - "value": "56", - "description": "The number of items that you want to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", - "disabled": true - }, - { - "key": "status", - "value": "status_example", - "description": "The status of the payment instruments that you want to get. By default, the response includes payment instruments with any status.", - "disabled": true - } - ] - }, - "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 which are in active status and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6&status=active`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/:id/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + ":id", + "paymentInstruments" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + { + "key": "offset", + "value": "56", + "description": "The number of items that you want to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.", + "disabled": true + }, + { + "key": "status", + "value": "status_example", + "description": "The status of the payment instruments that you want to get. By default, the response includes payment instruments with any status.", + "disabled": true + } + ] + }, + "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 which are in active status and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6&status=active`." +} + ,"response": [ + ] } ] } - ] }, { @@ -1914,178 +2785,389 @@ { "name": "Allow only point-of-sale transactions", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Allow only point-of-sale transactions\",\n \"reference\" : \"{{$guid}}_4F7346\",\n \"entityKey\" : {\n \"entityType\" : \"paymentInstrument\",\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\"\n },\n \"status\" : \"active\",\n \"interval\" : {\n \"type\" : \"perTransaction\"\n },\n \"ruleRestrictions\" : {\n \"processingTypes\" : {\n \"operation\" : \"noneMatch\",\n \"value\" : [ \"pos\" ]\n }\n },\n \"type\" : \"blockList\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Allow only point-of-sale transactions\",\n \"entityKey\" : {\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\",\n \"entityType\" : \"paymentInstrument\"\n },\n \"interval\" : {\n \"timeZone\" : \"UTC\",\n \"type\" : \"perTransaction\"\n },\n \"outcomeType\" : \"hardBlock\",\n \"reference\" : \"YOUR_REFERENCE_4F7346\",\n \"requestType\" : \"authorization\",\n \"ruleRestrictions\" : {\n \"processingTypes\" : {\n \"operation\" : \"noneMatch\",\n \"value\" : [ \"pos\" ]\n }\n },\n \"startDate\" : \"2023-06-29T22:34:36.173226192+02:00\",\n \"status\" : \"active\",\n \"type\" : \"blockList\",\n \"id\" : \"TR3227C223222H5J4D9ML9V4D\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Allow only point-of-sale transactions\",\n \"reference\" : \"{{$guid}}_4F7346\",\n \"entityKey\" : {\n \"entityType\" : \"paymentInstrument\",\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\"\n },\n \"status\" : \"active\",\n \"interval\" : {\n \"type\" : \"perTransaction\"\n },\n \"ruleRestrictions\" : {\n \"processingTypes\" : {\n \"operation\" : \"noneMatch\",\n \"value\" : [ \"pos\" ]\n }\n },\n \"type\" : \"blockList\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Allow only point-of-sale transactions\",\n \"reference\" : \"{{$guid}}_4F7346\",\n \"entityKey\" : {\n \"entityType\" : \"paymentInstrument\",\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\"\n },\n \"status\" : \"active\",\n \"interval\" : {\n \"type\" : \"perTransaction\"\n },\n \"ruleRestrictions\" : {\n \"processingTypes\" : {\n \"operation\" : \"noneMatch\",\n \"value\" : [ \"pos\" ]\n }\n },\n \"type\" : \"blockList\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." - } + ] }, { "name": "Increase the score of a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Assign score if more than 500 EUR in 2 hours\",\n \"entityKey\" : {\n \"entityType\" : \"paymentInstrument\",\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\"\n },\n \"interval\" : {\n \"type\" : \"sliding\",\n \"duration\" : {\n \"value\" : 2,\n \"unit\" : \"hours\"\n }\n },\n \"outcomeType\" : \"scoreBased\",\n \"reference\" : \"myRule11789\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n }\n }\n },\n \"score\" : 20,\n \"type\" : \"velocity\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Assign score if more than 500 EUR in 2 hours\",\n \"entityKey\" : {\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\",\n \"entityType\" : \"paymentInstrument\"\n },\n \"interval\" : {\n \"duration\" : {\n \"unit\" : \"hours\",\n \"value\" : 2\n },\n \"timeZone\" : \"UTC\",\n \"type\" : \"sliding\"\n },\n \"outcomeType\" : \"scoreBased\",\n \"reference\" : \"myRule11789\",\n \"requestType\" : \"authorization\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n }\n }\n },\n \"score\" : 20,\n \"status\" : \"inactive\",\n \"type\" : \"velocity\",\n \"id\" : \"TR3227C223222H5J4D9S39V59\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Assign score if more than 500 EUR in 2 hours\",\n \"entityKey\" : {\n \"entityType\" : \"paymentInstrument\",\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\"\n },\n \"interval\" : {\n \"type\" : \"sliding\",\n \"duration\" : {\n \"value\" : 2,\n \"unit\" : \"hours\"\n }\n },\n \"outcomeType\" : \"scoreBased\",\n \"reference\" : \"myRule11789\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n }\n }\n },\n \"score\" : 20,\n \"type\" : \"velocity\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Assign score if more than 500 EUR in 2 hours\",\n \"entityKey\" : {\n \"entityType\" : \"paymentInstrument\",\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\"\n },\n \"interval\" : {\n \"type\" : \"sliding\",\n \"duration\" : {\n \"value\" : 2,\n \"unit\" : \"hours\"\n }\n },\n \"outcomeType\" : \"scoreBased\",\n \"reference\" : \"myRule11789\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 50000\n }\n }\n },\n \"score\" : 20,\n \"type\" : \"velocity\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." - } + ] }, { "name": "Limit total amount in the last 12 hours", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Up to 1000 EUR per card for the last 12 hours\",\n \"reference\" : \"{{$guid}}_2918A\",\n \"status\" : \"active\",\n \"entityKey\" : {\n \"entityReference\" : \"BA3227C223222B5FN65355NR3\",\n \"entityType\" : \"balanceAccount\"\n },\n \"aggregationLevel\" : \"paymentInstrument\",\n \"interval\" : {\n \"type\" : \"sliding\",\n \"duration\" : {\n \"value\" : 12,\n \"unit\" : \"hours\"\n }\n },\n \"outcomeType\" : \"hardBlock\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"value\" : 100000,\n \"currency\" : \"EUR\"\n }\n }\n },\n \"type\" : \"velocity\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"aggregationLevel\" : \"paymentInstrument\",\n \"description\" : \"Up to 1000 EUR per card for the last 12 hours\",\n \"entityKey\" : {\n \"entityReference\" : \"BA3227C223222B5FN65355NR3\",\n \"entityType\" : \"balanceAccount\"\n },\n \"interval\" : {\n \"duration\" : {\n \"unit\" : \"hours\",\n \"value\" : 12\n },\n \"timeZone\" : \"UTC\",\n \"type\" : \"sliding\"\n },\n \"outcomeType\" : \"hardBlock\",\n \"reference\" : \"YOUR_REFERENCE_2918A\",\n \"requestType\" : \"authorization\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100000\n }\n }\n },\n \"startDate\" : \"2023-06-29T22:39:06.887628679+02:00\",\n \"status\" : \"active\",\n \"type\" : \"velocity\",\n \"id\" : \"TR32272223222H5J4D9Z8C97H\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Up to 1000 EUR per card for the last 12 hours\",\n \"reference\" : \"{{$guid}}_2918A\",\n \"status\" : \"active\",\n \"entityKey\" : {\n \"entityReference\" : \"BA3227C223222B5FN65355NR3\",\n \"entityType\" : \"balanceAccount\"\n },\n \"aggregationLevel\" : \"paymentInstrument\",\n \"interval\" : {\n \"type\" : \"sliding\",\n \"duration\" : {\n \"value\" : 12,\n \"unit\" : \"hours\"\n }\n },\n \"outcomeType\" : \"hardBlock\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"value\" : 100000,\n \"currency\" : \"EUR\"\n }\n }\n },\n \"type\" : \"velocity\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Up to 1000 EUR per card for the last 12 hours\",\n \"reference\" : \"{{$guid}}_2918A\",\n \"status\" : \"active\",\n \"entityKey\" : {\n \"entityReference\" : \"BA3227C223222B5FN65355NR3\",\n \"entityType\" : \"balanceAccount\"\n },\n \"aggregationLevel\" : \"paymentInstrument\",\n \"interval\" : {\n \"type\" : \"sliding\",\n \"duration\" : {\n \"value\" : 12,\n \"unit\" : \"hours\"\n }\n },\n \"outcomeType\" : \"hardBlock\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"value\" : 100000,\n \"currency\" : \"EUR\"\n }\n }\n },\n \"type\" : \"velocity\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." - } + ] }, { "name": "Limit international payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Up to 50 EUR international transactions\",\n \"reference\" : \"{{$guid}}_B2634\",\n \"status\" : \"active\",\n \"entityKey\" : {\n \"entityType\" : \"balanceAccount\",\n \"entityReference\" : \"BA3227C223222B5FN65355NR3\"\n },\n \"interval\" : {\n \"type\" : \"daily\"\n },\n \"outcomeType\" : \"hardBlock\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n },\n \"internationalTransaction\" : {\n \"operation\" : \"equals\",\n \"value\" : true\n }\n },\n \"type\" : \"velocity\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Up to 50 EUR international transactions\",\n \"entityKey\" : {\n \"entityReference\" : \"BA3227C223222B5FN65355NR3\",\n \"entityType\" : \"balanceAccount\"\n },\n \"interval\" : {\n \"timeOfDay\" : \"00:00:00\",\n \"timeZone\" : \"UTC\",\n \"type\" : \"daily\"\n },\n \"outcomeType\" : \"hardBlock\",\n \"reference\" : \"YOUR_REFERENCE_B2634\",\n \"requestType\" : \"authorization\",\n \"ruleRestrictions\" : {\n \"internationalTransaction\" : {\n \"operation\" : \"equals\",\n \"value\" : true\n },\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n }\n },\n \"startDate\" : \"2023-06-29T22:39:54.068487152+02:00\",\n \"status\" : \"active\",\n \"type\" : \"velocity\",\n \"id\" : \"TR3227C223222H5J4DB2X9V65\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Up to 50 EUR international transactions\",\n \"reference\" : \"{{$guid}}_B2634\",\n \"status\" : \"active\",\n \"entityKey\" : {\n \"entityType\" : \"balanceAccount\",\n \"entityReference\" : \"BA3227C223222B5FN65355NR3\"\n },\n \"interval\" : {\n \"type\" : \"daily\"\n },\n \"outcomeType\" : \"hardBlock\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n },\n \"internationalTransaction\" : {\n \"operation\" : \"equals\",\n \"value\" : true\n }\n },\n \"type\" : \"velocity\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Up to 50 EUR international transactions\",\n \"reference\" : \"{{$guid}}_B2634\",\n \"status\" : \"active\",\n \"entityKey\" : {\n \"entityType\" : \"balanceAccount\",\n \"entityReference\" : \"BA3227C223222B5FN65355NR3\"\n },\n \"interval\" : {\n \"type\" : \"daily\"\n },\n \"outcomeType\" : \"hardBlock\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n },\n \"internationalTransaction\" : {\n \"operation\" : \"equals\",\n \"value\" : true\n }\n },\n \"type\" : \"velocity\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." - } + ] } ] - } -, + }, { "name": "/transactionRules/:transactionRuleId", "description": "Deletes a transaction rule.", @@ -2093,49 +3175,50 @@ { "name": "Delete a transaction rule", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules", - ":transactionRuleId" - ], - "variable": [ - { - "key": "transactionRuleId", - "value": "", - "description": "The unique identifier of the transaction rule." - } - ], - "query": [ - ] - }, - "description": "Deletes a transaction rule." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + ":transactionRuleId" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "description": "Deletes a transaction rule." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transactionRules/:transactionRuleId", "description": "Returns the details of a transaction rule.", @@ -2143,49 +3226,50 @@ { "name": "Get a transaction rule", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules", - ":transactionRuleId" - ], - "variable": [ - { - "key": "transactionRuleId", - "value": "", - "description": "The unique identifier of the transaction rule." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a transaction rule." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + ":transactionRuleId" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a transaction rule." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -2193,55 +3277,113 @@ { "name": "Update the interval of transaction rule", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Allow only point-of-sale transactions\",\n \"reference\" : \"{{$guid}}_4F7346\",\n \"entityKey\" : {\n \"entityType\" : \"paymentInstrument\",\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\"\n },\n \"status\" : \"inactive\",\n \"interval\" : {\n \"type\" : \"weekly\"\n },\n \"ruleRestrictions\" : {\n \"processingTypes\" : {\n \"operation\" : \"noneMatch\",\n \"value\" : [ \"pos\" ]\n }\n },\n \"type\" : \"blockList\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + ":transactionRuleId" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"aggregationLevel\" : \"paymentInstrument\",\n \"description\" : \"Up to 1000 EUR per card for the last 12 hours\",\n \"entityKey\" : {\n \"entityReference\" : \"PG3227C223222C5GXR3M5592Q\",\n \"entityType\" : \"paymentInstrumentGroup\"\n },\n \"interval\" : {\n \"duration\" : {\n \"unit\" : \"hours\",\n \"value\" : 12\n },\n \"timeZone\" : \"UTC\",\n \"type\" : \"sliding\"\n },\n \"outcomeType\" : \"hardBlock\",\n \"reference\" : \"YOUR_REFERENCE_2918A\",\n \"requestType\" : \"authorization\",\n \"ruleRestrictions\" : {\n \"totalAmount\" : {\n \"operation\" : \"greaterThan\",\n \"value\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100000\n }\n }\n },\n \"startDate\" : \"2022-11-17T00:07:09.10057663+01:00\",\n \"status\" : \"inactive\",\n \"type\" : \"velocity\",\n \"id\" : \"TR3227C223222C5GXR3XP596N\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Allow only point-of-sale transactions\",\n \"reference\" : \"{{$guid}}_4F7346\",\n \"entityKey\" : {\n \"entityType\" : \"paymentInstrument\",\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\"\n },\n \"status\" : \"inactive\",\n \"interval\" : {\n \"type\" : \"weekly\"\n },\n \"ruleRestrictions\" : {\n \"processingTypes\" : {\n \"operation\" : \"noneMatch\",\n \"value\" : [ \"pos\" ]\n }\n },\n \"type\" : \"blockList\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + ":transactionRuleId" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Allow only point-of-sale transactions\",\n \"reference\" : \"{{$guid}}_4F7346\",\n \"entityKey\" : {\n \"entityType\" : \"paymentInstrument\",\n \"entityReference\" : \"PI3227C223222B5FG88SB8BHR\"\n },\n \"status\" : \"inactive\",\n \"interval\" : {\n \"type\" : \"weekly\"\n },\n \"ruleRestrictions\" : {\n \"processingTypes\" : {\n \"operation\" : \"noneMatch\",\n \"value\" : [ \"pos\" ]\n }\n },\n \"type\" : \"blockList\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactionRules/:transactionRuleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactionRules", - ":transactionRuleId" - ], - "variable": [ - { - "key": "transactionRuleId", - "value": "", - "description": "The unique identifier of the transaction rule." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -2254,109 +3396,110 @@ { "name": "Get a list of card orders", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardorders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardorders" - ], - "variable": [ - ], - "query": [ - { - "key": "id", - "value": "id_example", - "description": "The unique identifier of the card order. ", - "disabled": true - }, - { - "key": "cardManufacturingProfileId", - "value": "cardManufacturingProfileId_example", - "description": "The unique identifier of the card manufacturer profile.", - "disabled": true - }, - { - "key": "status", - "value": "status_example", - "description": "The status of the card order.", - "disabled": true - }, - { - "key": "txVariantCode", - "value": "txVariantCode_example", - "description": "The unique code of the card manufacturer profile. Possible values: **mcmaestro**, **mc**, **visa**, **mcdebit**. ", - "disabled": true - }, - { - "key": "createdSince", - "value": "2013-10-20T19:20:30+01:00", - "description": "Only include card orders 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": true - }, - { - "key": "createdUntil", - "value": "2013-10-20T19:20:30+01:00", - "description": "Only include card orders 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": true - }, - { - "key": "lockedSince", - "value": "2013-10-20T19:20:30+01:00", - "description": "Only include card orders that have been locked on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", - "disabled": true - }, - { - "key": "lockedUntil", - "value": "2013-10-20T19:20:30+01:00", - "description": "Only include card orders that have been locked on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", - "disabled": true - }, - { - "key": "serviceCenter", - "value": "serviceCenter_example", - "description": "The service center at which the card is issued. The value is case-sensitive. ", - "disabled": true - }, - { - "key": "offset", - "value": "56", - "description": "Specifies the position of an element in a list of card orders. The response includes a list of card orders that starts at the specified offset. **Default:** 0, which means that the response contains all the elements in the list of card orders.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of card orders returned per page. **Default:** 10.", - "disabled": true - } - ] - }, - "description": "Returns a paginated list of card orders." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardorders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardorders" + ], + "variable": [ + ], + "query": [ + { + "key": "id", + "value": "id_example", + "description": "The unique identifier of the card order. ", + "disabled": true + }, + { + "key": "cardManufacturingProfileId", + "value": "cardManufacturingProfileId_example", + "description": "The unique identifier of the card manufacturer profile.", + "disabled": true + }, + { + "key": "status", + "value": "status_example", + "description": "The status of the card order.", + "disabled": true + }, + { + "key": "txVariantCode", + "value": "txVariantCode_example", + "description": "The unique code of the card manufacturer profile. Possible values: **mcmaestro**, **mc**, **visa**, **mcdebit**. ", + "disabled": true + }, + { + "key": "createdSince", + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include card orders 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": true + }, + { + "key": "createdUntil", + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include card orders 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": true + }, + { + "key": "lockedSince", + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include card orders that have been locked on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "disabled": true + }, + { + "key": "lockedUntil", + "value": "2013-10-20T19:20:30+01:00", + "description": "Only include card orders that have been locked on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.", + "disabled": true + }, + { + "key": "serviceCenter", + "value": "serviceCenter_example", + "description": "The service center at which the card is issued. The value is case-sensitive. ", + "disabled": true + }, + { + "key": "offset", + "value": "56", + "description": "Specifies the position of an element in a list of card orders. The response includes a list of card orders that starts at the specified offset. **Default:** 0, which means that the response contains all the elements in the list of card orders.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of card orders returned per page. **Default:** 10.", + "disabled": true + } + ] + }, + "description": "Returns a paginated list of card orders." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/cardorders/:id/items", "description": "Returns the item list of a specific card order.", @@ -2364,62 +3507,63 @@ { "name": "Get card order items", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardorders/:id/items", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardorders", - ":id", - "items" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the card order." - } - ], - "query": [ - { - "key": "offset", - "value": "56", - "description": "Specifies the position of an element in a list of card orders. The response includes a list of card order items that starts at the specified offset. **Default:** 0, which means that the response contains all the elements in the list of card order items.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of card order items returned per page. **Default:** 10.", - "disabled": true - } - ] - }, - "description": "Returns the item list of a specific card order." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardorders/:id/items", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardorders", + ":id", + "items" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the card order." + } + ], + "query": [ + { + "key": "offset", + "value": "56", + "description": "Specifies the position of an element in a list of card orders. The response includes a list of card order items that starts at the specified offset. **Default:** 0, which means that the response contains all the elements in the list of card order items.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of card order items returned per page. **Default:** 10.", + "disabled": true + } + ] + }, + "description": "Returns the item list of a specific card order." +} + ,"response": [ + ] } ] } - ] }, { @@ -2432,49 +3576,101 @@ { "name": "Create a payment instrument group", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balancePlatform\" : \"{{YOUR_BALANCE_PLATFORM}}\",\n \"txVariant\" : \"mc\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"balancePlatform\" : \"YOUR_BALANCE_PLATFORM\",\n \"txVariant\" : \"mc\",\n \"id\" : \"PG32272223222H5J4DCRVC9DH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balancePlatform\" : \"{{YOUR_BALANCE_PLATFORM}}\",\n \"txVariant\" : \"mc\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"balancePlatform\" : \"{{YOUR_BALANCE_PLATFORM}}\",\n \"txVariant\" : \"mc\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstrumentGroups", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstrumentGroups" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group." - } + ] } ] - } -, + }, { "name": "/paymentInstrumentGroups/:id", "description": "Returns the details of a payment instrument group.", @@ -2482,49 +3678,50 @@ { "name": "Get a payment instrument group", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstrumentGroups/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstrumentGroups", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument group." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a payment instrument group." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument group." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a payment instrument group." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/paymentInstrumentGroups/:id/transactionRules", "description": "Returns a list of all the transaction rules associated with a payment instrument group.", @@ -2532,50 +3729,51 @@ { "name": "Get all transaction rules for a payment instrument group", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentInstrumentGroups/:id/transactionRules", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentInstrumentGroups", - ":id", - "transactionRules" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the payment instrument group." - } - ], - "query": [ - ] - }, - "description": "Returns a list of all the transaction rules associated with a payment instrument group." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups/:id/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups", + ":id", + "transactionRules" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument group." + } + ], + "query": [ + ] + }, + "description": "Returns a list of all the transaction rules associated with a payment instrument group." +} + ,"response": [ + ] } ] } - ] }, { @@ -2588,92 +3786,197 @@ { "name": "Validate an IBAN", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"1001001234\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/validateBankAccountIdentification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "validateBankAccountIdentification" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." +} + ,"response": [ + {"name": "Unprocessable Entity - a request validation error.", + "code": 422, + "status": "Unprocessable Entity", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"https://docs.adyen.com/errors/validation\",\n \"title\" : \"Invalid bank account identification details provided\",\n \"detail\" : \"Provided IBAN is incorrect\",\n \"status\" : 422,\n \"invalidFields\" : [ {\n \"name\" : \"iban\",\n \"value\" : \"1001001234\",\n \"message\" : \"Invalid IBAN.\"\n } ],\n \"errorCode\" : \"33_01\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"1001001234\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/validateBankAccountIdentification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "validateBankAccountIdentification" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"1001001234\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/validateBankAccountIdentification", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "validateBankAccountIdentification" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." - } + ] }, { "name": "Validate a US bank account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"12345JHDhjkf67890\",\n \"accountType\" : \"checking\",\n \"routingNumber\" : \"121000567\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/validateBankAccountIdentification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "validateBankAccountIdentification" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." +} + ,"response": [ + {"name": "Unprocessable Entity - a request validation error.", + "code": 422, + "status": "Unprocessable Entity", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"https://docs.adyen.com/errors/validation\",\n \"title\" : \"Invalid bank account identification details provided\",\n \"detail\" : \"Provided account number and the routing number are incorrect\",\n \"status\" : 422,\n \"invalidFields\" : [ {\n \"name\" : \"accountNumber\",\n \"value\" : \"12345JHDhjkf67890\",\n \"message\" : \"Invalid account number.\"\n }, {\n \"name\" : \"routingNumber\",\n \"value\" : \"121000567\",\n \"message\" : \"Invalid routing number.\"\n } ],\n \"errorCode\" : \"33_01\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"12345JHDhjkf67890\",\n \"accountType\" : \"checking\",\n \"routingNumber\" : \"121000567\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/validateBankAccountIdentification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "validateBankAccountIdentification" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"12345JHDhjkf67890\",\n \"accountType\" : \"checking\",\n \"routingNumber\" : \"121000567\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/validateBankAccountIdentification", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "validateBankAccountIdentification" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)." - } + ] } ] } - ] }, { @@ -2686,50 +3989,103 @@ { "name": "Request a PIN change", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentInstrumentId\" : \"PI6789678967896789\",\n \"encryptedKey\" : \"75989E8881284D10153ABACF022EEA09F5...\",\n \"encryptedPinBlock\" : \"63E5060591EF65F48DD1D4FECD0FECD5\",\n \"token\" : \"5555341244441115\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/pins/change", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "pins", + "change" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Changes the personal identification number (PIN) of a specified card. To make this request, your API credential must have the following role: * Bank Issuing PIN Change Webservice role" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"status\" : \"completed\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentInstrumentId\" : \"PI6789678967896789\",\n \"encryptedKey\" : \"75989E8881284D10153ABACF022EEA09F5...\",\n \"encryptedPinBlock\" : \"63E5060591EF65F48DD1D4FECD0FECD5\",\n \"token\" : \"5555341244441115\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/pins/change", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "pins", + "change" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Changes the personal identification number (PIN) of a specified card. To make this request, your API credential must have the following role: * Bank Issuing PIN Change Webservice role" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentInstrumentId\" : \"PI6789678967896789\",\n \"encryptedKey\" : \"75989E8881284D10153ABACF022EEA09F5...\",\n \"encryptedPinBlock\" : \"63E5060591EF65F48DD1D4FECD0FECD5\",\n \"token\" : \"5555341244441115\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/pins/change", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "pins", - "change" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Changes the personal identification number (PIN) of a specified card. To make this request, your API credential must have the following role: * Bank Issuing PIN Change Webservice role" - } + ] } ] - } -, + }, { "name": "/pins/reveal", "description": "Returns an encrypted PIN block that contains the PIN of a specified card. You can use the decrypted data to reveal the PIN in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PIN Reveal Webservice role", @@ -2737,50 +4093,103 @@ { "name": "Request a PIN block", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentInstrumentId\" : \"PI3227C223222B5BPCMFXD2XG\",\n \"encryptedKey\" : \"75989E8881284D10153ABACF022EEA09F5...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/pins/reveal", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "pins", + "reveal" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns an encrypted PIN block that contains the PIN of a specified card. You can use the decrypted data to reveal the PIN in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PIN Reveal Webservice role" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"encryptedPinBlock\" : \"63E5060591EF65F48DD1D4FECD0FECD5\",\n \"token\" : \"5555341244441115\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentInstrumentId\" : \"PI3227C223222B5BPCMFXD2XG\",\n \"encryptedKey\" : \"75989E8881284D10153ABACF022EEA09F5...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/pins/reveal", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "pins", + "reveal" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns an encrypted PIN block that contains the PIN of a specified card. You can use the decrypted data to reveal the PIN in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PIN Reveal Webservice role" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentInstrumentId\" : \"PI3227C223222B5BPCMFXD2XG\",\n \"encryptedKey\" : \"75989E8881284D10153ABACF022EEA09F5...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/pins/reveal", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "pins", - "reveal" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns an encrypted PIN block that contains the PIN of a specified card. You can use the decrypted data to reveal the PIN in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PIN Reveal Webservice role" - } + ] } ] - } -, + }, { "name": "/publicKey", "description": "Get an [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)) public key to encrypt or decrypt card data. You need the RSA public key to generate the `encryptedKey` required to: - [Change a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/change). - [Reveal a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/reveal). - [Reveal a PAN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/paymentInstruments/reveal).", @@ -2788,55 +4197,56 @@ { "name": "Get an RSA public key", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/publicKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "publicKey" - ], - "variable": [ - ], - "query": [ - { - "key": "purpose", - "value": "purpose_example", - "description": "The purpose of the public key. Possible values: **pinChange**, **pinReveal**, **panReveal**. Default value: **pinReveal**.", - "disabled": true - }, - { - "key": "format", - "value": "format_example", - "description": "The encoding format of public key. Possible values: **jwk**, **pem**. Default value: **pem**.", - "disabled": true - } - ] - }, - "description": "Get an [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)) public key to encrypt or decrypt card data. You need the RSA public key to generate the `encryptedKey` required to: - [Change a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/change). - [Reveal a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/reveal). - [Reveal a PAN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/paymentInstruments/reveal)." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/publicKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "publicKey" + ], + "variable": [ + ], + "query": [ + { + "key": "purpose", + "value": "purpose_example", + "description": "The purpose of the public key. Possible values: **pinChange**, **pinReveal**, **panReveal**. Default value: **pinReveal**.", + "disabled": true + }, + { + "key": "format", + "value": "format_example", + "description": "The encoding format of public key. Possible values: **jwk**, **pem**. Default value: **pem**.", + "disabled": true + } + ] + }, + "description": "Get an [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)) public key to encrypt or decrypt card data. You need the RSA public key to generate the `encryptedKey` required to: - [Change a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/change). - [Reveal a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/reveal). - [Reveal a PAN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/paymentInstruments/reveal)." +} + ,"response": [ + ] } ] } - ] }, { @@ -2849,50 +4259,103 @@ { "name": "Calculate transfer routes", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balancePlatform\" : \"{{YOUR_BALANCE_PLATFORM}}\",\n \"currency\" : \"USD\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferRoutes/calculate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferRoutes", + "calculate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns available transfer routes based on a combination of transfer `country`, `currency`, `counterparty`, and `priorities`. Use this endpoint to find optimal transfer priorities and associated requirements before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"transferRoutes\" : [ {\n \"country\" : \"NL\",\n \"currency\" : \"USD\",\n \"priority\" : \"crossBorder\",\n \"requirements\" : [ {\n \"description\" : \"Amount of transfer must be at least 100, and no greater than 99999999999\",\n \"max\" : 99999999999,\n \"min\" : 100,\n \"type\" : \"amountMinMaxRequirement\"\n }, {\n \"description\" : \"Country, street and city is required.\",\n \"requiredAddressFields\" : [ \"line1\", \"city\", \"country\" ],\n \"type\" : \"addressRequirement\"\n }, {\n \"description\" : \"Bank account identification type must be iban or numberAndBic\",\n \"bankAccountIdentificationTypes\" : [ \"iban\", \"numberAndBic\" ],\n \"type\" : \"bankAccountIdentificationTypeRequirement\"\n }, {\n \"issuingCountryCode\" : \"NL\",\n \"paymentInstrumentType\" : \"BankAccount\",\n \"type\" : \"paymentInstrumentRequirement\"\n } ]\n }, {\n \"country\" : \"NL\",\n \"currency\" : \"USD\",\n \"priority\" : \"wire\",\n \"requirements\" : [ {\n \"description\" : \"Amount of transfer must be at least 100, and no greater than 99999999999\",\n \"max\" : 99999999999,\n \"min\" : 100,\n \"type\" : \"amountMinMaxRequirement\"\n }, {\n \"description\" : \"Country, street and city is required.\",\n \"requiredAddressFields\" : [ \"line1\", \"city\", \"country\" ],\n \"type\" : \"addressRequirement\"\n }, {\n \"description\" : \"Bank account identification type must be iban or numberAndBic\",\n \"bankAccountIdentificationTypes\" : [ \"iban\", \"numberAndBic\" ],\n \"type\" : \"bankAccountIdentificationTypeRequirement\"\n }, {\n \"issuingCountryCode\" : \"NL\",\n \"paymentInstrumentType\" : \"BankAccount\",\n \"type\" : \"paymentInstrumentRequirement\"\n } ]\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balancePlatform\" : \"{{YOUR_BALANCE_PLATFORM}}\",\n \"currency\" : \"USD\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferRoutes/calculate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferRoutes", + "calculate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns available transfer routes based on a combination of transfer `country`, `currency`, `counterparty`, and `priorities`. Use this endpoint to find optimal transfer priorities and associated requirements before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"balancePlatform\" : \"{{YOUR_BALANCE_PLATFORM}}\",\n \"currency\" : \"USD\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferRoutes/calculate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferRoutes", - "calculate" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns available transfer routes based on a combination of transfer `country`, `currency`, `counterparty`, and `priorities`. Use this endpoint to find optimal transfer priorities and associated requirements before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)." - } + ] } ] } - ] } ], diff --git a/postman/BinLookupService-v40.json b/postman/BinLookupService-v40.json index a3b65f7..95bab73 100644 --- a/postman/BinLookupService-v40.json +++ b/postman/BinLookupService-v40.json @@ -19,49 +19,101 @@ { "name": "Get 3D Secure availability", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"threeDS1Supported\" : true,\n \"threeDS2CardRangeDetails\" : [ ],\n \"threeDS2supported\" : false\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/get3dsAvailability", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "get3dsAvailability" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,434 @@ { "name": "Estimate the transaction cost", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost using an encrypted card number", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal with 3DSecure)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (recurring contract)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/BinLookupService-v50.json b/postman/BinLookupService-v50.json index 92c1fb4..26d1b85 100644 --- a/postman/BinLookupService-v50.json +++ b/postman/BinLookupService-v50.json @@ -19,49 +19,101 @@ { "name": "Get 3D Secure availability", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"threeDS1Supported\" : true,\n \"threeDS2CardRangeDetails\" : [ ],\n \"threeDS2supported\" : false\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/get3dsAvailability", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "get3dsAvailability" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,434 @@ { "name": "Estimate the transaction cost", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost using an encrypted card number", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal with 3DSecure)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (recurring contract)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/BinLookupService-v52.json b/postman/BinLookupService-v52.json index fd8110d..311e3d6 100644 --- a/postman/BinLookupService-v52.json +++ b/postman/BinLookupService-v52.json @@ -19,49 +19,101 @@ { "name": "Get 3D Secure availability", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"threeDS1Supported\" : true,\n \"threeDS2CardRangeDetails\" : [ ],\n \"threeDS2supported\" : false\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/get3dsAvailability", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "get3dsAvailability" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,434 @@ { "name": "Estimate the transaction cost", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost using an encrypted card number", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal with 3DSecure)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (recurring contract)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/BinLookupService-v53.json b/postman/BinLookupService-v53.json index e109ddc..228fad0 100644 --- a/postman/BinLookupService-v53.json +++ b/postman/BinLookupService-v53.json @@ -19,49 +19,101 @@ { "name": "Get 3D Secure availability", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"threeDS1Supported\" : true,\n \"threeDS2CardRangeDetails\" : [ ],\n \"threeDS2supported\" : false\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/get3dsAvailability", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "get3dsAvailability" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,434 @@ { "name": "Estimate the transaction cost", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost using an encrypted card number", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal with 3DSecure)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (recurring contract)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/BinLookupService-v54.json b/postman/BinLookupService-v54.json index 1990a39..d2d0d90 100644 --- a/postman/BinLookupService-v54.json +++ b/postman/BinLookupService-v54.json @@ -19,49 +19,101 @@ { "name": "Get 3D Secure availability", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"threeDS1Supported\" : true,\n \"threeDS2CardRangeDetails\" : [ ],\n \"threeDS2supported\" : false\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"4111111111111111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/get3dsAvailability", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "get3dsAvailability" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,434 @@ { "name": "Estimate the transaction cost", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost using an encrypted card number", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"encryptedCardNumber\" : \"test_5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"shopperInteraction\" : \"Ecommerce\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (minimal with 3DSecure)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"costEstimateAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 12\n },\n \"resultCode\" : \"Success\",\n \"surchargeType\" : \"PASSTHROUGH\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"cardNumber\" : \"5101180000000007\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Estimate the transaction cost (recurring contract)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getCostEstimate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getCostEstimate" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 1234,\n \"currency\" : \"EUR\"\n },\n \"assumptions\" : {\n \"assumeLevel3Data\" : true,\n \"assume3DSecureAuthenticated\" : true\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\" : {\n \"countryCode\" : \"NL\",\n \"mcc\" : \"7411\",\n \"enrolledIn3DSecure\" : true\n },\n \"selectedRecurringDetailReference\" : \"1234567890123456\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"shopperReference\" : \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v37.json b/postman/CheckoutService-v37.json index 376ad3a..f237fb0 100644 --- a/postman/CheckoutService-v37.json +++ b/postman/CheckoutService-v37.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,202 +778,266 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.3.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"{"checkoutshopperBaseUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/","disableRecurringDetailUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/services\/PaymentInitiation\/v1\/disableRecurringDetail","generationtime":"2021-04-08T14:13:09Z","initiationUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/services\/PaymentInitiation\/v1\/initiate?token=pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91cndlYnNpdGUuY29t.pupr33DCNDCi6ZWcCbuL1_kaz57Jh_Ibkm2mkBZP5gk","origin":"https:\/\/www.yourwebsite.com","originKey":"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91cndlYnNpdGUuY29t.pupr33DCNDCi6ZWcCbuL1_kaz57Jh_Ibkm2mkBZP5gk","payment":{"amount":{"currency":"EUR","value":17408},"countryCode":"NL","reference":"shopper-reference-ekvL83","returnUrl":"https:\/\/www.yourshop.com\/checkout\/result","sessionValidity":"2021-04-08T15:13:09Z","shopperLocale":"hu-HU","shopperReference":"shopper-reference-LZfdWZ"},"paymentData":"Ab02b4c0!BQABAgCgt+NI0xLstN4SvHGzWhRqhw6PMY1WymPaPRkvmAZ1rk8qrsqC2Fp8V9r2Jy\/5kzJ1+jmP56FkJz2TqJG5MTt\/ksfRnH0ljyM5Mg1p0EbcOZ6sTy6ClUyO6zn9Ka3SPiE1fAkSe\/wUj4wfWvZHMcRM5Dy+w43IMRWH7htanbaeUOGW6YgudizbdueIHu57gApsyQuxOxOqmifBUCksVf4nEy5kvpv9\/qfb\/QeIiKefGnxNpcftaYIHDPuEA4K\/+kKf13vt1OZf1RspFc0qDXFRKkTYHrnbGJS0W6T0sPNwHiG5mG+40A1FxZWhgimUFQ7\/HcbZfHu5Mq9slUysZarI+FAekNL6O5xIhZxBGbIdW7ilSpcQosak2lKATmwSKk4fnheenwFRCf+lJErIdlqmkFAe+go1fJ0qxIdwQZO8z\/HdA\/jtOea17faE137ZoTprvnNwKOC1KRBxBSac12OVs8VVxKbPvFQKTDHPp7jzsTQlb9xF3cZ9KRWkzlJxFZ31u+c5ngezyC51JqurlH9VIweCY76vE9WZmBrj86xQ6mlEtBENFo+YSkGW7r8\/rZlLraMIt17fdIqcyQeBM\/aBiWIH0mp9ktsN5Hj1YrSf506SWjJDmp\/BZ3E1ZkuV+GgdJfpeIZAzja48UfvSxPwv01tK4dxIUOfi0l9OB3aEwhASQnCZbKJDc6rkkvxgdLp+AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiff8fordfxJF3vxiYAd061rUEWVjkGNR0OpRcV8Qgk5dMNzGewODwBGBXzYiov4ledGZi4KCYpr4x6ujQ3Lgf\/r\/DThHVVS0juFM\/BDFgc35GL8tQ82CA3JgqQZx0f7TmZqohgPPgp3k\/2g5G\/vt0TIyFUOHw51wzO\/x66Bwgm++565WS06R8l+GLLw1Gl0Zknz0zsi0GGvgd6Y4\/8wlwZzyXdGpkhtW5G0Uxjj1ZyIUiYiD4AS\/SIHBx0LsI4yXkT22a8dutkyBnKUFfuoTGvGBacbPPfL1g7BU2He3Cqqag0Ab3qfOFuOaZ441Z0u9pc0x0xdc\/T3q8R0rmQHUoleHIg+V5bwEsNi3KLg5ZWX\/bvU6F5+\/\/ufB4zfe2eJV5QKJ\/wGEDSuxg1cYBX4PPLycL4a0tl4Wdjs015E5bBnOM5HDeDmdN4eR6tTGZj+P\/nVDQMBFP1oTFjy5SHAF4urQh8hpyRA992MwWkugGbpQCQc+YivS5pxH2JTqa8OsXFUn4Fc\/ZfbF40yphHxNfV980NwCwj0ZVabX+vd+2aOUHYqXIwmh\/2f16\/\/rYY6RJVePbSev\/\/\/rsAmGNTze3Rs5jOxcamoR0OEmRtytepBaEe\/nkNcCLsFhF2Tu7uhQPTSoUfMeDApT5se1zNMDU7rCruMR+M5DOSpX+W3SaRBYCyoeivN13dR5pk+uiQgExsyII6nykFhkJcM\/HKgMhBuCV6Uv8BhghySGS\/355yQpzfgxBi0ek403FWPBAw8ulf4KWrb50wasfivTTP\/KQyFklpQ1rX+35Eq9uOqOcTKm2xuvdqMRcVGbIIP2F+1mtBYX14tTkA49QNWLt5xuHSdzCQy4LCnzWruXrXdI3ZYdcF30ZPcdbpK1XFYpakYojiOk2QzSU2R45iqcQlFuxoMHxs+iL1n3vtOzyTNU1XZepkKk31IlJ3aTKKYhTfghDWJHm7JclenYgvObmZ5s5I36N4FDsocxAV5+c014Z49tH0etUAHEqTHpUd5YFbM7PQnLQgp43zTN7NUDwP9hrYKguRX\/b2WqruviyO4NZrKWJqtwmywnqT9NcjGP0+hJ9hVv86zhZuGjZNVyZGCj1p0r+tbHqufN9RxSchcM\/zTN0RDmffwU\/Z3gk\/qtjDFevIkki6TiYboLugnc6ZEs3gpo+gClgmHZ5dLuscwLU6EjCaiZoj12KBiRxTNPzEnOaRqK+YnWCKTamaMnD6SO5t1SLIi7Nf+uHkLygXrZ\/zZWh\/alF1niwmDp4NpZAO6efOC8Q\/ixahG6zzaGqNI5eUpKND2B+Uk45kOgJCffgPL8XHRGz88z1lc+wrnV35bw2kIiY5frf1vwSzjEFS1MQFZVrBDTmPkoq0VSGdja1LmP8htOYcYCAs3i2X9GxwOOycADCZjbWUikbwknWBSAf1lFrh39x5me78zOz0fSPOX\/d3C3pysK5u+zAMiPc2vL9nWFpG\/1K3s1xwaIgaS4i+BWvlO1i9iNEzqA1bocTU0q\/KX3wE9C08j8SrWsi6yjuzjFrU5syH3Gz8lHgsv4QTnmf8L4AQDR5kOjRWqQkArGPQ0E45pDaO5sK2ISxwgNIpuKtJ6+9MFM7vYGrHB9H3JomrZ8FEEjKKP8cUI2weIB9LsEpQJskMdKwMDdIi4dPgzvRaE2YxwHxJgtWGOd5YZTocHhaBYnr25dx8lKF91C4LohOzjzd1JCDJDsOmQ7FRZNsnz0s83tTFfjHcz\/ZBuaAPj0txCL7bHLfPrmziaGuf9wQ4vxqW0iAR5Cvmid+BVFJIz64Gww0GqThnHSyWRXYZeQ1DSG98orStea9gYEzqy8KWwrh\/rhSrDsC1bN+pZfZbslEYgB0riFML22owiGijw+n7dJZCyp2abifEocR260ffMxfKJQBvc5aPqGp+kA4na+l8GxHL\/+Yxn6SiSfgD5dVQ6+3nlhcGtBZBut04KRz7CSzQ0kEyL0T7MPG","paymentMethods":[{"configuration":{"canIgnoreCookies":"true"},"details":[{"items":[{"id":"1121","name":"Test Issuer"},{"id":"1154","name":"Test Issuer 5"},{"id":"1153","name":"Test Issuer 4"},{"id":"1152","name":"Test Issuer 3"},{"id":"1151","name":"Test Issuer 2"},{"id":"1162","name":"Test Issuer Cancelled"},{"id":"1161","name":"Test Issuer Pending"},{"id":"1160","name":"Test Issuer Refused"},{"id":"1159","name":"Test Issuer 10"},{"id":"1158","name":"Test Issuer 9"},{"id":"1157","name":"Test Issuer 8"},{"id":"1156","name":"Test Issuer 7"},{"id":"1155","name":"Test Issuer 6"}],"key":"idealIssuer","type":"select"}],"name":"iDEAL","paymentMethodData":"Ab02b4c0!BQABAgAQOXfyuJdcL0vN3gOePL4QWWQDWZd0LGPXi0C3mVF6yNIVtGxiUpdzI1UakkQbYHn8YL7Tr9UfSnGr11hvBzltGbnVP1Vusvasn8g\/En2dWWHdP8noxErAICPrypiG4VZ6rq\/b7GiTEuiWRLSXU0Fm7TmwbWfsU8xepTrdDLov+R7nUOXq9cZMZtsdEWDxZTS676VRvPPzOvmq+9VMZPKaqSOdFZQemZYJiTUGntTHtXT378jUWS3pv3V3BiyUy1OlgSNcfAejVFgpZtMFwS1Df6rwCi+uYvmj0+BhId3xLPFXI1pG2Tmpc491X0BnpCT25rESPdLZEGY6XAeUk4EbfBDSwjEfGkRd5coapUOPD1NlEYloW+drqGJSk8xz6a0Ikq\/nw7gVWUDqruWw6SPXMEfVAjGItHODnWdWXrjLTQuhu3BYrMy4xchwk1yKmJBnKsd\/mwg3px9zLZojAfE2KisG1X1Amy5jHMNnLEFAkywTqUMFcC8V5RSS3S8uMgBSnF5JCVKTQb+KC0KilRuq68UtlBk+jvzkTGcCQrOlq87MQWVbp\/6Mu7Ng4T29W4D1OXg8k9bp3BpNz+8jI6viUlwl8FR2PrumLZe4\/DhfnH1mHFgI0+7HCgNfYXcUdvICFkbiELQcP0PPsVXrs4I7aBo0mjeRW7cncuj7o1zvaRACy\/VCEXKEOZ10Uagna4YAAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbjsE3jTDdtjckWCfvwTDtha\/9AdnTpE6V\/TBqC19+bBUiFsW+3kRbX8jZRgbHbbI7\/YmA==","type":"ideal"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"MasterCard","paymentMethodData":"Ab02b4c0!BQABAgCCognvnK3ydYPFoFKGKJEJleIkYbKAN3VVg5WXPNE1ud05KRqgsNVdvwuu9NEwpkb4UutL9KBUWA3feoTBBAWVJt1qpgZXF+JZOzfJ6BSc1a0zowCMQz6wtCI\/tWBxKxaKFaljAv30jga3+JCQkpU\/4gq2ubsNWcOWJWDFEvH15WN4gungZebQzS220kOfwyd6IS8TnwEWd5qg40rt0xD8xBaPoNYd5Cx\/C92i+6PtJzIX2SYBjGjG7dZmKno9RTXawhkjJmssEvFGgw9S9U+\/MYwKBel\/daKBTI1c+JIc4zqd523iev0YCruNLHv7pO4MTy0VXRwizCBURJZ8ZskCUbDM8FFPwxcel7CnF6ts4R0blmKKZCJr4VaX3uInfETy6x\/qUULaSatmFusDtePyQDzZA\/8c1jX3Uq896mnGi2nsK0DDeFzGmPA1rKEg77YGPtu2MRL+7\/9d5WOoqBzTe8h7Sp0uAP8mwx1ySXq9hdf8tkXrnB+yDP+DcBA0+sBNdx6PocBCaPfK4rwXZanRwFisZT2vrV1+e4iKdBAOExLm7\/mTlmhD8OpXugJkZuEY9K634aDcaNYB8aK1flD5J7y+eifQ0tuc18brADlJXIqpVx3uPQyA6BP1dNW\/nIFZBVnayz1lZXErLEDz899zB++kRFUKaqWAdGRUVU3DgRAppOX0EK6OiasLkA2YdsdkAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZrwQHzXOXVvxGnqd5Cf75gjjoMkWzjgBSDVUu7iX12mv5VN1NNupVld4T5R40AiBQ==","type":"mc"},{"name":"PayPal","paymentMethodData":"Ab02b4c0!BQABAgCNokZKlG1MT3DDsUkmC0wuH87A3cCl2OZGQ8uu9Oc2na4sg1lYO19JLWqo83fNrq2L+9caG\/6t802SVQtD2ywXUeEU\/JifxXHbgD4zgC6I2XrJB2BrAVlfEu+Ni2Mkmty6R89owPoD4BH2BBgnb6pKYbgHJPP9qJj4TD\/oNst2sMkSXPNJv5v75ZhhJpkYM2MOO+eSgM901ssLWT9lj7ppbiavqoO8lpGDNHD\/IsJEqGvWhpIXrOFLMAx6FsS1xnTljouQv1kWYG\/p5esvpGenhWQkreUl3uYfv172B+3pRpCtHCL8qMflB+pdYKL5c9Sn3oTfCd3YtmINOtEMVcH8zew5VY6jr04yvc1x8sUYcdhovYfm8C3kGuDG+TEfuet7QFeRcBx\/zzv\/GIxsxqaJWA2mJEQNqjMbYrv1PzQLA44GcdgFI6xpT\/AwNoj5MALM6GYKs\/2\/0T1lYRh\/\/o3hLMx9R\/X5QuiufQa5zn2uZCyiNXEDaJ1bLNQ0gGQ3X+dkClEfidD1oxfau8uanfQ\/LZNsFWvWS9qaEyLSRBYEfQDDPMYujFy+C80PD51rDOG0nsppKLJ89kPR8M2F3OGE4PG2ENPOBtBHuYtnSYTUFFw3jSL3oZ+O+a3RBDlURp8QdtgZPYZHG6WBIb0AiN0WK1Xc+i3sZQ8s+nJrshBBRRBdkOu3rQvcuTX0wzkVrcOqAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUnF2up7n17FMeYCgsWh5y7+HaUMslBb\/NQw7cuTFWeKoMv7CLTU4HNxt1bdkYHC00DSDxA=","type":"paypal"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"VISA","paymentMethodData":"Ab02b4c0!BQABAgBSuoz29NnQafIoNneRKy7zbb7IqZLX6ZV8vFZ3N8ZkrkcwfMrKsfHesG4Qeh8R87jaWboITvb7muraTbZSTFbULBnyIlKS8j7g7WnKuxoTF541aiEjRGcF8G+5mktPsM09wFcgEKMJuI8CbztrjGMirsa8LINAqqMlJwsvwJqMDmBjj6S+lEmq6dxGNIjBZsBeSqsihOfZ1UB4Jz\/Ne6gWwvhl5gEaege6mdDxs\/y\/g\/93Ml7XxwkGeedbh43LcLPg6lLPM1QV5NQ7Qt1vWAA9mw2m9ev95xitkZRNoMXgQuk\/M9kDwofWVkmfxUP8W8olKjjK0p4rQAEpT+ORT6RPkpNBpzVzvEgwFUpZr4XP+LCasjf177sLL3MoZUJ4fZ8QfXaPLaIq\/nY2FFESItOU1ZotNF\/EAsHt\/OHd0Zq9RSTLeSOfGMDgo\/itkS9dWrQOoEdYT\/7plVxnKo46eABC4cvTn4G1s6CdTJYgNXkA\/IcMc3maFvyyfzNcDGihF1VwpMpWEDg+I5is6FZBU6IKJHXVEERmuLSzi5OImCn4CWXKXXrM4+3U8+OtUQxN+pKBXvxaP1eh8VigtWmrn94MtvSWlrJOOFn178cV\/HqZNk\/COf4hqC8qilfpSzvkMteg59N0sLQ1hNV2FlLZQjw+PTzu\/f8onV8M8Euu5DRkexCsL6yXSFRqurrTdabb6j8NAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQRC+LRtIEHnt1T9Ayq9sA4kWH6yF\/z2vdEl6fMR\/uE2\/6SRXJvd5DqpPfhoLNBPeYjJ","type":"visa"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"American Express","paymentMethodData":"Ab02b4c0!BQABAgBEGvruCjCI0v7n7aiHYnRKwExtyMG\/Nu0gW1S9yqchaWGFbonc+h4sZf9dK60J6iSibKWhjuYolkUVx\/+GwSb\/vdZN20mJTlrXEEPAyQI4qMIb5QVKa\/WTVbZdeOp9kDhCbn8fBBN58Y\/Uk0TdHOH4wfz1rOYaferr7iucPJXZB8byagvbUFvzwpS8GzoDKrp6XNgbKkd0y5oEeE17Cl0d3fGgbCJk\/B5D\/kTYEuAzqGZUA0eKQOkZfcnc1J08aDNLK5GPNpNjZdy2oeYAmsLZY3Zube1orrk1GsVIT4J0BWA2fw\/TfGPzxMsJZc7SfmErZSyJEWpDZraRYFIXMZ+IT5gFYzORRkkMFyqhvoUCGTyK2jRZzk00XCjMZRke\/fCe5HX0gxDz8zBDWpCR6ekvfk6GKkKtaKAu5tcQjFICarRcX3wIPNYhxrtESiWtzTugjnH1ZM7FqacdrJ92crsb2u8f5uxPOSFNjJwprkXXIdiSYxCiJsz\/vMy+usvfw+vGCUtwDaBXzvWAf3yYvr6ZI8r3RxMRBFvFpnRHpMDhuVGkV+3S1HUWV8xExq7MuY4jEPlWTsvM\/eZyXmLg8O3MKvYioaqvUDa9kecB5aBAw6y8+lSWgGV1cHyPl2RiqUNXdrz6+fJ\/KmQ5x57CFgw4tiPoivUJ0uTS69F7TZQjohA1QzcXutAWtXzBglU99635AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZfDoLu\/zISKFsToh1bg0F8aRlRFGDHwqcUx7eum3yCLQD21cqfKmrTLyacrlo5aM4kt","type":"amex"},{"name":"SEPA Direct Debit","paymentMethodData":"Ab02b4c0!BQABAgCbwCT+JO8UEoxoBPrI+qyUS4vR5TT646v1MiN\/gUM4MVm7jekk7Wd0Hmrjk1\/NEg7NTAcpsfZDBOcMlQeuTeDsEaC4kBf3tqsttfw+qY6TbaFLCtgNIr5wJ3dm2TwVhFCYVMArwJ5zoBIsoONUWpSKR11DY6zE5vuDgtifNA0YiN6h6rzq8O9GuCrCqUJbu23PMejDHA0rHDOKyxyOmBXHRvUHhNR1\/Kwtrvx+fYANnAHgkznTH4ldSXcuaMVtZFqcpHZTiYpLv2ydiT14PzipiODpRGiXy0nO7b5N8Rs27nYxlgH\/tDcI4eF4jl981TPKlF+u6XEOGm4Ebyya\/BfTDp93rKRMxo6K\/LrfI9J4WaA2tEZo6eGNbRuKPpBlV3ASu7wpCfSSw2NjouVTCkfYt8+XeeJeIIYZ0p8AWjn4LTwarmSVZ7cYw9b9eCU4XX\/RrcNgoLFPXEr8w0McUF2n0GVWDM7Q5b9UtoZ36yk185LXmoMuy\/\/vaBIvE8m7Qlgo\/YROv9Uem6muLu4hZzW+V+WEKAmwGL0eJZCdjAeGWz6c0nty8PNMUv3pf7tTeYN1gsvQfqlij3ILsRLcw4kNYvElnGlCv8dgu3cxlz6DsnMuy\/EqKQMZAIoUCd6eF19I3NfvAo2j5MfrpSKS3QGLTP6TXKqgTNb6d8sVD8gRKhCDK4Av\/N0p2CHGN\/YG5xaBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWQL\/0ruABUrzlPtx5llC5MJp\/\/iChDPZ8r7lkIf4QbzPP+8ETdxbzNZU4vwKTmUjffpLdQA2aswKEtOzYM=","type":"sepadirectdebit"},{"name":"Paysafecard","paymentMethodData":"Ab02b4c0!BQABAgAIhU3xKBF8QbmAvj\/6ONqIvvCbMr98epy6\/KIV9u+yJz2pSj4PoMDLbJxV5PZ1Ykxaa9WjWvTnlZ9NgeB+eoO26MbmIoAsMw8knjay+FE0Pyg5Gj0JXo9Ibe+D513sf4qKB+wQPXfUEqkniitTi8o+jyhbB123rCAJWvbZfPOEKE1RE+FHSEZyVvJmHQPl5y8vWsCKBHjyDK5oLJjtxDfbdoPRrMc2ogNsGlfI\/qpIFW8HXNRKXpzCj+YF4vif8Zn6Z8Eb52rfNZI12xVG6hZnmox8BmMgmSnGkCwnY3O3CFpDTZlCbJo\/XWSGgEe3xeHk7PiZSAjPOVHpDDALRB\/wZVf7XzGYqKkiwtjnzqF8kGYy7XUduLeVF2z4C\/QzgF1DzqzIA7Lf3V+0UBWhpDqHJCrwkAWyTCaOXrqw7T66pT7MtZr5V3lGBUqHk8T\/hNwcuzg9wrx5eHse\/wdC1+2eVay3i0YWyikn\/rYt7z1iyTTIyz96IxxoyMIq0zyULkniylcCspd20\/XgNhbrRmdAt7qPmD9rH+Cp7abIXbbiAM4LWfn9yOWsOsALSDr2TGZDjsmMISCXzLHU+SDOrp2SiJRJ3NHNsTrdEbX8I6w7zTaviTsNMEAd0t9gbyb3kW1F2rqzJT\/UPeQb5MJQ\/wqGGYbIOe\/XGE9BKxQoluKLFhBv4haTKeq9Rr3VsuBtdUxoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifew63Hop++4N+AhTkkdsSKG980izIWOIBwRrfCIR6YloEnJY\/80hintVkjZcIzDoQYFnf\/zExjiwIQ==","type":"paysafecard"},{"name":"Bijenkorf Cadeaucard","paymentMethodData":"Ab02b4c0!BQABAgCpQPz5Zr3DETTfSmxZeO1skeivMnITjgMXOAmpc6OHdPt04Qs0PjkWF\/7+nfFXEyS6dhYw6aOGIFTcr7R2xav\/88lWDCUhP1G7TtUl87npuGEsmlaqS0Kasl6BD+s5HQ1rlplfffupDBlFj3rePozF449gWoGX+bNq1Vgeh7StI7XB17K\/FDqEYQi+N0NUEtJpCDottPouvo0KgKuED9r0RQjAb8k3nNEuAFxkLTCEfgrRYv7HPDil4dx2yqOhsbv6DXfq0k+JxIFIR6HscRXmggWx1yzou4O4OB5UepYBSlxoJMKqEQXFQxURkF9RI8gOyG++2KYLHHolZkqRImnxeSZ88yZ3zP1eLbaw96TmsXcSk2Sjg5qWEr8RpJuL9UaXEpaOLaqm6E0QMXkbw7A2945YMYTc51tIB8hjY4GOVsoVqkKz2c4Md6yziKlv4XcfI5cMic1rI9q3x+NTSnpNAEBY9XsfE3KV+5dcwIUvIBw4BGkH8Wg9+N\/WZFeRLDKgmFwZ8kkTYMKaax03oHLR5\/NyCBX6GiySwLOqm6QlHtTIVajskcW5qQO9gbz\/JWxBBBtyAdeThE1Qv\/09fZULNYPZ5CgTot0q32It2Jash\/jQGf0lKLDjqWu6Xc\/rPeFDk6M5b6k8NZqSj+fegHK6+NmyFMzaBLWK8uyeSzUCbxDHtI02OGPTOI40iSVTnQfjAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYEvni+wibC9so6deSW0g2CaF42cgtTYVc0woMUDCt0gSvKHfPkxEExT4rv2Pj6tBy5nTOrvmoI73RtR","type":"bijcadeaucard"},{"name":"Fonq Giftcard","paymentMethodData":"Ab02b4c0!BQABAgA\/VmZkWktBF5weoHZawlAmhz9rivBPh3eF24ct7JDXb0uvbxZCJ6cweI0fTU+i4iyExCthFm7I6wxgRLrEznH6033kj9J+rr7d32BywPOxNq+dt3yG3lZN\/LfO11k\/HeMobXvxU3\/al4nszGTXyVMiLTgf84vzyCYZWifPx6pakWjMeHI0qTYF2cbUzsGsoob+AUIh8HBQ3cHs9eRVTUI1P9QAErzjYCNzFljjayFgG6iWuzq113TpuLuSoA3YHn09moZ\/AGu4HIUnTK4Cfp9fu5\/FMzFHzRxzf0jxcy8xrW3ClyHPttsHxytACCvCt39xyryiNcHnmnZGzvcOb+R8DLTG\/jXLe6KjQHfWl1WjrCOHr74PDBglYf1wvicYj88iqQLI6TEzJopctDxmWI4FEyfQw7DEZX\/LooqVUwYblRuV+k1qg2RVJ8y9NaJn4m4R3Ti\/5yc9Wq1OrvpYUbFMB56DuCBm63knV3sEEFJRSUtVti6uDLP5NA7cYM0NRWLjyxYBMiI\/r\/zWOEg+mLjspuO80gQeg6aC7PzfVY5bj2YGJVY6TmSmVdNZAipa9xzHH4RpB5R1Pf3cBT6+xchT6i3ZFVC8VY9+iCxxdpG4TYeqcLW6pVe9hHAe6vq97G8+F6Gghqxb7Z\/DlxIPRuu+D4lWa2mshpGNUTdbF4xuzhDxi3\/zjFAoR8jPpymbJQZoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVU7KkI531G4lKfLWRXWEry7pNzwCMfzANGS3PGZeYA+2n31DEhwavXsiPBvv3Sx31V4XCQiEEUNE0k=","type":"fonqgiftcard"},{"name":"Bank Transfer (NL)","paymentMethodData":"Ab02b4c0!BQABAgB51DuujA7vUd5HEKFbHqfqbOvXmmtjP4CdUi0JruTVYdcMSuKAATLdzyB3ayN6V5KrvUKitJV3ogvhNPtJ7gGBKB3idHBUb6v2iy+YEvuTb\/\/bJ04X3OxxI\/9f70qvVKtbSjpXhgmJrO1E0evJrIhml12sCVTaAL\/paykhzWFvHzMmUZV62KWOayWyiMEzcnndbG\/CkJ4OMe22ipfsuNr8TTEQwzmAMiSt77lDdeN+y0JiyQyLHfR+gV57FC5PDYgP3ylpso4W1VXCcGx6jRFTwHhb+gyJf7HqrWErYl83GietwukM6TB261cadT9NHbSfh4FCTDvL6twoRzhefGbRDuO5xvs569K\/e9VCSEnen1Fa7vZP04azaZ7mhfYUcL60CFoWgNkJt7NrFlmSO71BzpyvWwEJYFnhk8vLmjDd8UqitLyV2hrusnyK3ESHiE\/k0d5Cbil3CB3QEyhw4zC6WMzXIutTMvLaJyn13nR4SGWhObWomXkSvX9NKv8NrZwy2BXheRAyOHStD3QLBORrAiq9pEWPZF9wv+eBJFNmDHCXwK88nlKbFKV4WzTO4vGPbNVGrHyM9DVIRHt25neVZBYcDGIyVrUI9txBm3rL6QUqnt4ly+5gDFNLjhpFs26mkcex0++7VgpuzcS9WUOuiOIY5uBplYS1aPesyxW6uhAypRves0tGoyoUelhL0ZXbAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaOmKTlIMV4D9THzNGG1oMsJb6VRZpIiBiSEWovHLgIBa1wHI3H28jenqzyq5a+7rK5XpMhLpq1i0LLu","type":"bankTransfer_NL"},{"name":"Pathe Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhO2Q2JTyJ44bDAkSQQlkgI86+4Hz\/IMv3o8J2Xk9Ky\/Ckz0b68SDv35YholJFlJezRYrYWntzXfcjcfrv+HsRqej9Aieb8bGo1NrSSUa5FEpB\/aGXAP5Bn4ph2UzppDyACOOy97jlG6CPiZZZ2RPW9\/2SBP+Zwl3fzE4PyON4uM5piN+b9c9mQBlUZ5trTAgcOPBPhGpdesNqOklsHUYedp04B5RH4fyMDQTotP7WoHpbptMTPhLuuNn9rFRaIZrf4n+hnsiGa66KnGa\/MK0RKpwI5vgcY7TJt7Ym9lqwcnfjwYSW73hEeZj9J4r1nhTvc1p8SSnKN2wKCs+Tj4Bla+7pPzJjxpiNdeENOj+DVKAc4qh7lrGvLs\/eM6sTwrmk6k6bqD2VfC7yIlcQuWgwEDyU3BELkun+\/KBfwH7O9qC8YdEQ6ftHknq5qu7esOgmKUPrh0+0pO8QSnuzeObGcmVZsKZSWPK83W10XUtd\/Eb557f+E53C5wurfM6hlkaoLA9Xy4tuq3OyzJSn+U6f5jnYpWoPFbiU6FfPI594VjasrFZiaZ6pZFVvqe3z00sj7J3FEKtPDuABbgCoshdUeqkftUh6hNGcP9YieHtKEXxqiXFlk75yJ1qZeLvh4HeBJUqwctWgwyCirIBqMTI3icF31cdnwMYj9x6pnK56ahAAcSdzbZPYiLmLBmK2IDnwAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVSWDvE6KaKChC2HUEIlit8WNjy2vPU\/veo+SPjHQXporYlv409pRe+Ott+IgTXXbCtWN8G6oOrVI1ht","type":"pathegiftcard"},{"name":"VVV Giftcard","paymentMethodData":"Ab02b4c0!BQABAgA+A4idTs3qRa1aqP3B0gIqp1\/XQ+I4v6akD6AGmgH5smozPUK8f8UzFSBqwgq74fKmLWOj6S563FZHvcS2DdPKSATlh8bdG5htjyaFWkyHsuyga1\/fX5cE2FVFTNNoIsS5elKNHMDEXko1napgYprIJs0Gcugn8wFRZzbd+iVIePbiyQqlNdgdcrDOMncTEsRVR7COekfWBpmskzsVjFeG7h9LRqbtyGQ9py\/u51MUW1t5OL57vuxI5mE5QqdNEvIG+04QdIa7A+GuZTzLvnw6mDif5RZvD7BLpYmvSCBNCHJLh7JYxJantlkz6YqBf7cQjHBjZGLvEnDLJ9zEUDj6A1r9zIrPG+Ds42PyPPpskOZSURGZdyrXcDBrU5UToyEylRi\/gtnHMawdHnw3VIDmmTNWm4ma4XzQgJM0yd\/AhZkqLGUWnPeNqKMIhN\/ZOrql39QeB3aj39yAJ\/+XYiRFeAGK+o865GFONaw68JjO8q7OOPADwbDGUn24g3oTtFtbDtjbv\/l8rvkA1wc+DQomK6pezGf+P5hkKQgybaxG1ryfXyaMQbv1hojwVFRC8tWbVOy9bBqGmbZb3ue2jt7lcXOtx0xTswFXzB8C\/EoKZQ0H9Wi\/HgswZ4y3SxepNzD2utrehnbyWVtZ2uyyOM8X+qT9h+98W0V0vF6d7TTX2RB0vtmbGcwIpf6SXVn39CZEAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifY0HazzPpi5jbgPfqO8hww7YnpWeRhSLkbwJPQ5hYZJXsXn1Ma8rnwpYYi8jfO1FJKBq0hid1zapJg==","type":"vvvgiftcard"},{"name":"Podium Card","paymentMethodData":"Ab02b4c0!BQABAgBzwaQU+Tg8IgY6LWZFZR765RW6ZQ2DZYU0DtHpL1P3XYk5TPwF7aG7Yb5nc6wFkt0kpUSyCFKNn0h+L61XtT+NoDCTTYCHfA9YtTwb34NY+YmZGdKeukR7TQJscKNPEFxzc7vdRXxJ0vTBuyXiLP27ms6db0e5BtAfgF7UlVHoBDhTBl0UZSK97b0CRrH3orO74z+H9UjeP141HR7za7ay9Jk9gXEtgFQxoEjacvjC+IuRu6MZ+rfrTiApkcFcnap95mwxYQdzPWkZH9ka2S9NFVSBTx1g1BmFopj7nNQBHnru8DXVxnF2THJjf9N9MElcFcKnMDf45szoYTQ6dW+0W+wTKcQEUL05yIaULsYTfqgFegKJtdHBadGgUZu6d53dCK6TH5gTxSmV8gxuOMFfJ1XKJcjJ\/WWFkgRA+9FJSd9vrGHxVP4ZXAEzt6SteJ8Ew76VvEOkAp9K3kASCLMrJDKifEV7t\/5VDQkPzg\/+EWScYpwtD0Y1HPziNaum4xEpHl\/Ivbr41ZVDSlgc3u3z0ET9VPz6sWP59oPY0pWy+45XyL5fia729tJCLxCPC6HxMTf9YR9DtneDA0fQWS8U3AS2sTiwYasVj9EPOY66YBqoF2A6127l08qV8OJaZS4enIvuVxtE9VGB9ZXVBB9t3GeSj+121B3fQpcvWbfavBCmqv9Z37f3YphvyLrb6gkEAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZqakCpG8Uf0AtkpxtcdUkLTz\/ij5cbS99cT58Cqwnjo0muipxwf1dRNtDIAaluVuyvM6IHNGfql","type":"podiumcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","optional":true,"type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Maestro","paymentMethodData":"Ab02b4c0!BQABAgBqjbzap3VEI1UTDAV+YAxi67UHIAXoXAQYl9pQDP8PGTVnvd5WGD8MFgUPYUSz3zjLiRomZirNNwEdxns3glOLxnbasMe9cit5CbEmP9gZu4MMCouutZg2qhhrPBLewc\/RKJJPetKUjW2W5gHXEUcX1tdt63sg2Z8o5g3y5+WqH2NnoHAQN8DYXZ8W3jAcltX+Uz\/5hIhV224RorNAOM8tgTB6ADAM9mMfAU6YEHHB5ADVdM1IDtRbg45c4CdK0nIihZx\/kIcDW8aygpWMpPCuFjFpO4f0cAtXW05N8KA2VjUAqjt073Hzv09fXZjVV4rLo29NNP4qiVYIm1GRQa6jQGfyWfVzYRCp3BM07YN4ISP2rVNkRoe5c0Tae0JHb4pUJ3gzr6BOXEySl\/Q0rSPPEJtmHGEdtmgRKG9UWhiwQVBhvU6MDDEkdCbfAeSByT0yMwmFgqHZVV6e++2ZSOxiMj46mj7x1e\/Jl8v9OuP+YoqYlWqZkdC2Cccm3NB1+8vkuid\/sj+x9mmjHfx63oUZB0WkuRJvYcDrF6ije8C0TdcE4XWVOOc3jHsOSSq62d0pssHA0Q85YP2w2RiOuPrPI7nddvr8X2U8C\/UhO9jHff9\/3TcygwEEBZ8TPWJaFrDPzHVhMTMQdqcWsMCOguIsrWReIT+xytzNbv31WkhfyRBKTiRvzxvH\/sV4UlKUv4+4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdjiFWBHVC0eyVNBpmJjARVoFkvoNhGDK4dId7U+\/B8peVyQA4VYtDRvcwUea06G++wmYTq2","type":"maestro"},{"name":"Rituals Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBDd1AVaDRsad2eK38Kfjl+D+sqlb3Jhz4EhvuJXUFSv7cO0Q0vxYf2X81UR8if722Ts440VycfZaLlMzlCHnDhqeb5azij96SubBEZGYVdrpup2WLI5TrPBPJlDwcqbK\/AYbZjvSD2lFnJnrCu2D03q\/RE+CiXudWYMOPwPxA5uazZ8dlXXEmvh3KacG1wVwNUB93jK0tIFy4T97wrNPuBcgoEqpzumVZr7GVdu5ZsKZQsiDUHshopdhTZZvht0NEiCeE7dULsQw0uRh0+a6YHDsjGfB+cnfEhkYDr2BtoJvvsLRUIGs2ph2aW6szoFs0HP\/37YecNjQIKPSRN7XN+WCAxUlcFoYPbT9DXUXjHQMzmGCghy8FiuLc+abBHfw2GOv0nUQveBMSkyAaw9Ae0ViCTxCv8VmBLdlexnd7T8AA8frVZBFD9nA4BleNwkieZ8Jmlfv2XSUYb\/tVdovh5mueSd7sdfp\/zGwtjX+CQSW+NlSaKja+Lyn+RDhVUnIP+u6rV7+gdXLgfaAUqfFWi\/FunGZFiS1\/kM9YJrFbNnyEf2Rr2DscAtgVpyaEpy5ynUIaVXvYSxyNqilxX8MEayJkG2HE7617sy+9QQ9wR3um4K6bbeTaUlM\/TPrKTrsCMipFYevgFXMv57Ra4eLBzQKOIyMr8UpN+561af25XXxBQulOAgBXuMINjKZiYcCG8AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdiOv0yNIw1pb7GKPw8hm4kjqLasknYB22lS1sjVFDm6RQ\/TkAi5N+4zlIbmeTFB6qENcBY6","type":"rituals"},{"name":"Hunkemoller Lingerie Card","paymentMethodData":"Ab02b4c0!BQABAgBOMjIh114zJyMJ3guhOub7m4v5km9d8vjTnuzgFZxUFngv9ioM0baZgjbHF1kitGBWUiWuffyLY6+NOXg5DRbxNZAIJbfW\/dxPkD8Vv49TuK7XKKXvaRpBpLiEVIzLlvqFC6KF5pohIpjioYTbK+VH9vzjGGzyyvG75QoXz1nZj2LmVrds83Gb5JjBxeBtqwROD\/0RvmS+wf3ybnoeh\/06SKaRAWz1W98PMe9AAvDT2s\/LFkPWjmFpGnWDK7mwKOWhIULLfnJZOD0pnb\/XorX3VPae8sJBEJdhuZgVXk+aox55WTAUpGKW+8UU+tHY1kda38Nn4ndRQh781os0v6edJ1EFxlFJp8cIcXeEf7kvuIoufCPiLf79DSHxJVCsEA2Sq7uKcTnlyaoz3uXWXp4JA6lQLfZKvlwrzcx04TdCXAO70Y8G1PSE7HMAV1bGLdf\/ce7Sys6VTGHDg+UZNLl4rY4PaGyvhrSbMBWjiolIKpfSnO+nn0U0JEbFLHRHCrM5ojth10+pLkSaaFGR+HBhKQ+uVaSzw6758\/yeV23TondUCl9uMETryEkpQvEN2OxgH0TBMnmB2R9ubwYjGY\/QytJZDnhwWBm9jbMJIoixEIArUiSZR2jSuq2pTtb3crGl8gnMDvz6yvY\/Wp7pWo8Ay62pB\/EfWw8yQkqCVisNehAcd2Pr2NCcmD7w2Ix4aIkKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXPaKLqHcQLV4IYHaD6ib2xySERpw3Mdd4CedXeAqGC8nKp0pPLQ46X4V3TZg5GLBcHk36UmFt1E","type":"hmlingerie"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","optional":true,"type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"UATP","paymentMethodData":"Ab02b4c0!BQABAgA+ir9YQzKM959cQ+mKHK\/ACCzf+epb7mwhJpeemAETLlPukrlz6cc8tv\/XEzHYcSDuBLD7quWFzkxWPTVI3q1XrexQk9bWgqV3GLdkzHnP0isR0JLEreivj6Z\/af\/q2IbbAd8c6v3Up2GLZgOPkEwiLytz0pmrbDgE+klCIoZ3vYKhNLJHDzAPaT5cyg5Rk5pjbZxz9x3WOajMut2HF5mQw2245mtaKYLT9SCcNCEOEB6PbRCLYYSGCvm0fE3tF1QsqptFoPReAx3U2NJw3ssOZ+C4W9H5qPR22s4HCvB40ZQIchux9O9x4TiQkD\/F8d055V51py3myBZyIXW3IHol483fYM2FsVs0PMkE+t4v++cKgQHw9I\/T4S4xpIxGhdxb\/Epz7i8QhxturHB\/3xFbr2JmktzFtLI27NJ7kdhfRE9WghQIMjmqulLBXc2iF63kuHKNyZGqsyr8OKS0mmGdWgyaR2GKEQvJh0kEBa4ZcbN5dWF7C+bba\/QGg59dAttGIEDXYM2aTI\/o8uKvPKyWrhtzkCmCtj0iMaDEKSiKVJVqfCQVVbgl8xyQXA8ChDbGo3TTPRgLUAWDllswkTfBfvbXtL8sNNUAa20zwo5xAMyw2gt0H8C3xnWBDy3jNmqVzEyeSe0xFvPXk7deYlKytZ6SUdUsbc83qaOqASv1NhBOL8ewqdnnYszv1JTDp8loAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffr6Kyg+U\/BHwUbzhvvBmSBEwlB5SD3xWgEq8rzCViQNW6TPdGagXycftIVUlnJ7Dmp+","type":"uatp"},{"name":"Primera Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgBr+wD\/5Gyd\/QR5Gd3nQfdZ\/wpiiOWsTDw+AhVQV7IJwyxacuJmewIRy0O0O81MoVvRc6hb7vCTfETXbBclLTN2sxgwWMJEAAW468XQPi7oVNoI9xrn6f1cscY2frgc3L+zRA93sCADMPVK4VoJ2BHkTCOoDSXeFcc\/RhLBjn7Uo8tVohMsWGuvHvDT0GyDne2V9cQeJ\/8Kv2Wrc+2eO0vJYfspLRPvFF7DitCYRqPknDpREwvimweEm2vZbfZO2DGrBizZyGIep1HK35rVk8\/d5Ep88WoIt1IXlXoZODsyx5Z1NkN6RSlPQtZspLb5An2uxmDGd1eziUsFJJikbpn2EONJhJxGNfdJjMbvRA6qdE+1Kx6Dlk+s9EQ96Bg8Ho\/19Twxvcnhgb2xJyoC\/EkE6dEA\/nwQZbwyTOw74PeKgBFcbx1ZvcblarESRTc8R6JB1fuEoOKVKJeifkpoLU16dvLZ7YBQKnUKQmskcwQG1H4A0qn\/kq2ztY1JdI8haDVh2ZBQEJEHhMGXqeO4kX96W7y0auXb46NfGhRzLmu+82I9DUg13U\/MvatGfYiTd3KqlBHxgxvx3DOFKnE2NKeoxiyF6bPRZFKvDNhDXZFSF55f8Mgjwo9CD+WCF8YbM7GlRxHVq7STP3pFI8CSLScNaPp+YsezSo6\/6gJeOdmw3RD1CQXCaSJeywTMaC1\/mlaRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVgriUMVq7kjHCRe8bocfRBC4Ox6x2N0IFlO7PWaHuFYtIoTGvSa2zyXKIDP+WrqyPZ1s2Hj408pibGA3Il5Gw==","type":"primeracadeaucard"},{"name":"Fashioncheque","paymentMethodData":"Ab02b4c0!BQABAgBTwcz72WQ\/rWZS7SgH2Vn8g7rWbGC8hUIDzjU2RezIuYG+QZc7dRUdnWEarKjDsnnHwhj2+bFRC6dHaG4OcSbbQV3Umfw6DKYzAQG237U859Oeb8hv4sgi9bsZl019pZ1Lu6eNCficLEVFklBNG7zOcTth3OY2fzrE8WwtgAQy3MoncJwwDtU7nY\/kYV0ld1yggEDG2\/nsg8qK61wXqkvpUxWGHeCZqjivzFdA66PHPB05iTj0WlsRigIoHQ6Z3NAri6kKe9oaoj1wOVpZ3LScUcAo87w8CpbYvSROEOnlXfLvOQD5tBO8sJQo8oZ\/Pw8\/Xz0UuAn3G8My4vR6wgYs+5bkCYpnU0yF+4g8\/nUOs3V3IXb0ylgoXO4X17Mb6O9\/zfWxwNBXiVOUFWPkBA527y69lJ7s+P1xrdBFBTOnLsm2nrSNu0o+DKHYS+OXbK3niywYaEAp5viCBAbbvm2ueq3Wvz8t6lt6TnQx\/RFxE2YS7wKJEZqWeGyn54xwrgtFKkXwL41tUInvOy3DNIQ+QCGAwDt3bAqiVqpmyeu\/5d2w4wya22HXs2vc4M1BQ0nEOs2RgOQul7LYyz0iOm8IpkZLIrGuq5Fh9\/nyTeKalYCYs1yLk01qn5\/RTLSzJDEeKO3IpBUXt95xY04Riu22XzdS0LaGZXXsjTihOUVvrhDq8gRHzofaaaaN1Dig\/07XAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQbcBV13AySSRL7q9jEJ66VjBiy1pyPT7p+5rNS1f6nFrX2yxwUAuIrtfRkLo8msxea0hY6+GBy8ntAl","type":"fashioncheque"},{"name":"NETELLER","paymentMethodData":"Ab02b4c0!BQABAgCChzD1kgErFNDP4mOuRgJyNzV50gjQtREUn9li1iXE9EHo37JVkIbGJoWIArhh08dqFhUJ02+GUJ39M\/pvwgTm0NX2i\/EoWJ8MSV1oNY2imOd3\/vB1qZ278DwNf8L2mI0b33DZu6LQomKOX+9lt76RLbeQR6ub2CdDZtMI+k795cNCTqpBNeUjGF+03GVfq\/PmVVIGwTeRMxoXICK8bMdUMIK9lf7RQKeWBdtVdwsCE\/3Vxo55m\/BSNMV1TBx9Gb3DiW947mYUXFp8dTHrTVXubFGD1ps6uI75qRzkmbsk\/W7giZxW6h5\/m+ntyxzG5QVMbwHYWlxMLD84AxkG+++4snsbE\/m0\/EF1rLA9a+4C9AngtZMjLugMRGt8fwuzYbFQPY1mY7hxxJsh5DjY5AHPNSWUljSQXR3Wpa4\/67H8RZ75XiKIF7P+B+R5twWFx96AHtTd23pusLHnPYl0VoN9eOiA257ciLFPgeyx3\/RUpfmPllsGgy59+7Go4fCe2jAsAWjDQcVRMs6HyFFQ1B+GRQZetNPLCBpgKVThhiiOikevHsNQ3R1W1OIRfdPe5Jt8sZMNWo9N\/nG4yqb6m0Wrq2FXdecjc5PQDkua6VfokjR4ikjBQ1UPeYJo44f0obmLH9d6amH1yMM5A2nv930VLjPuOCvyj94otuZz6jiAPhCdNAEXB+8IP0clv4vQtIWoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXOXG+\/p12zPuFSinBYaAl9PsoaBeSuADkiwhiK30SH0JmDstGNO3aHTYsorlFcraXafcoQuag==","type":"neteller"},{"name":"Adyen Voucher","paymentMethodData":"Ab02b4c0!BQABAgA4m3Fmy3uAkrABwPHO6ZuMqte1FwI2I46Gj7wYm6jAfz9CYWqYqAmiMdnjKlxjfYPBws\/eDmYwypyJzUmSuuQ0ABXtT0dF3Miip5GISHtTRPuY4PVc6rhd+faICXJq39e\/QI4sFwPg1k1xu6i3kiSZMG5qcOaUbCcmbo7sapxu2b0neAnLj7uoqJGt7wWArzEoJ1OY4qH8+D7f28Y2LFo8cEd2rva5DTBzTLP+tksXVpzqZW9pkOXT+e7ECLHc3ahwtqLmv3jJssBQi7uj2yDl64VoPaNfwhAOpEirY0dNenpOewqksAgdmvMVecekfiWPbeuM9cyrrAUzypnB2IfNmaIsRkRkmS\/UXRQclz+IT60QhoowIPlvGiZdoAbkh2O+6MKcSqhmddYLur0F+GTi3knseyff6r\/6Ovg6E8ZxUlGaR0gZ2b79Bf0INA3jYYZgWI\/mV0nTfMZ8QbWwanQFNP0BNyKe0i3qhdKgvapPHcMiVW2N8BQZk86umQTn72mZg5J\/D1D3rJ91TZbNqSSKKUdIcePlSpjd0hV9J+NUTWCpg3xOUyaAD3oZLBRsStmiFKEhFy3T0rw5m0a1A1fLENYq\/vg8cj5K8igql4PtLKfNVckEls9EvBLfW0vz00nqqXRoZMgmFh+Em1H2QHJpbEQvq1Co042ZFGx7wfZADBBhhyKK03Bxpag6b3csSQ6kAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQlEAX4IlhbcsGZk23cCI10LWUzOFL+evz7R23OxpQ97a248sf6C+osDDcCQu8Y5fQNRGSictAY55XdhLKNrS04=","type":"adyen_test_voucher"},{"name":"AliPay","paymentMethodData":"Ab02b4c0!BQABAgCf1auSGoTYhtg498bFc6haRU6NhnNLG1J3AxjfOfY8MQTk3r2R6Z4ApsTvCopJHVz\/SQzuanZGKuD9Eg\/1Ie45c4tVKgO1jlfBR1d9uMjKIXcSGpzt1Zbw1HRCdHfUKv9kgQFgdSm4PEQ9Xtob0Jr2tGjm0HWmEPFN01rseW8Q6wxvBbVk1RhJ74rwgmGGr7GZXw9zRPaiaqh6Tw5F93pILHz9MFi9R224925BjGeF5trdMM3guF2u+S9X+9YdFPx0E\/uioYPWL4iUqHb\/eqUMHL+Ul56z8ZIakje6Cne43bwAiv8n1XcXtiojd8pO4TAYEPEO3OFZId6g048gVzaBj3Z4NOaKpPa1hkricwbm0D66+349Xt+baHl0JOtPOR\/bQwRHWop7rALG\/hRjivbvrCpER8iEiKaPxNSZoae93Ue9btPL0VhnaWD0NpcxicHuvZbe9dKffnCRDwdb+oqKMKSrgSNGdkeaO+IoAPDhvZGD09WFGVdWFGwsm2reUVcOfeSkeAfiITI\/ZcFlXcV94JXvvYP47XgvDrTnubDVfwK60hfVLbzywzd1cV3+nf56ss3b7I782r8RXcF9GJyfNdlvI6NW7aeAwsBPHcQhHZiT+5VHXbbxyDd4qT4tN\/vcRXz+HP4qULTxg6wxIM4hztcW2X9aJFNhzFYNbvi1uRAgDu1+S5xChfsEqkutUHvVAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffDrYa7tRXGfbYA6Ge161KN7sgVl2oNzl3HnXezyndspuFFgDrhoiHelB1iOfRNcojjlLYY=","type":"alipay"},{"configuration":{"merchantDisplayName":"Adyen Demo Shop","merchantIdentifier":"50"},"details":[{"key":"additionalData.applepay.token","type":"applePayToken"}],"name":"Apple Pay","paymentMethodData":"Ab02b4c0!BQABAgC0zYM5I3qqo5UGCO0s0MdIxxxd7b29RLo+dgUPNfEFEeolvX6qNqKBHPjX+bXZGskIJFxy9YWbQQSZkEAEqPydtGr7rvRr2MIekcs0Q9jazt62yAypML6Oraktk2w3JDPZuKjzHo\/Z+YYx+\/1ZHOlpWL\/rGB2cZXSO1ZSx5EQKgfTmwlS1NkFfgQzl8sQC1htidsIOZGw9xPWbmscNhpqEZCYlDOfEzRHElu6Y8g5D0yHOXX5TVwXetum+LM8CvClX+DEzp9miM\/0TMV7J+3XtUTA3xcPT\/+byDfygb52WGmiHlEma7rDGdlBQ5Zz7Tbb8YW5y2XNp7f6RZ3ZWy8MR+V+BbFhnbvRP3pSsslI92uiDgT1j8Hk7N9cWPBHmp9eOb+iYa1yFEe9BkadGdYiDTlSrWJSG8goTRFBKRj15d43EvnBu4BXADSh0fNEXykhCktcaolHuusbFAr2CV2D\/TA8V9FwvuNXGAgU5szzvG+jMCztRg7EFGElbAWPMYyENO1EjUpQQ3\/76jS8qXBej\/OK1WtmUoCO0pltPoOPaF+swtitwsF\/t6L7gAEbmufAEpmBc4uhAhfSjh7vhurbWpbsWkeMWT\/i+xAxX75WzCc4jLHEmTW0dDoWK65aHpFqNhc9DnJMDNApF4jy54\/qmzZhQMdv5ZkOJ\/eUcZWybsBD2yl6FzpkIlHBCE+ZZXvK4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUn8cdiUMVFJnCsfxIFvccbkVMDMBW4yRrz8Qb2XROpsA2iEH05CECs8gLQYfrZbxIkjAOxMzQ==","type":"applepay"},{"name":"Baby Gift Card","paymentMethodData":"Ab02b4c0!BQABAgCUrswZjd5pZD1KaDp6qqgZyn3\/U0SZj\/slMY3xnJoJV+2FyFKMW9sobzu85X7UGm455G1HAsbm8EyIFVshnlD1Sd5ImzSgVn5dvjVytMKuWmQotUFVoyhg0SaHX0ZF\/+ZbqR3xaEYQvhAZdMJ2zlAObRs6CwHKA6xYPQIgoEPVxBhGCK1XLkFWRm0Q9+sMj68\/sa9EKf\/+osl+3R4O2ZB\/4cM4p0jvOBD3FYEZaDGJbONomic58+i3Urf82LOaU\/VBIfGCOLY70JwUwoleAR8+tLSiJRLks9ujxgf26naSML3f9H6OmjjG1LMe2Nt2RZZyFyMkGt84ACJ7k\/q\/gudxWskc5a7ZjmgqO4mrBmRmy\/DZxcPcWavLS+m+8NXaPZken1i6L53mvb+BryRtIOCgM+AhGyUaPoXQOF4XbLqhNqTHRh6UjH4MPLYJrVoSiWSvRsv2J1268rFTHyCFzvqu9v4LCGiP7B45AFJnKphFb62kr6bk5vmdbpc\/S9WUwq2avCbU\/dGFyIyn5rdEammsfp2X+prIEBkMdpN1arErttEpMoCtpKwMqytrvgrDzRgK2iPWAWu5EXB076VJXQt4FZgvWVH77p\/d2ZB1nxCNNp5cUj9ITvLwugnVDqJVwdt3Ze7m46dOj8F+AJAX35t9WlGhmh3Meoiq6VJwCgUSEBCfaieS3oR9KDXDCJYZ2a5YAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZ+JyZ7fnomDQmxQ9n8Ai8mE4Ud5mN8EwTSRGw3hkUzlflEBbmW6H0jk18hDxxxXoMoirYssuOCdtbE=","type":"babygiftcard"},{"name":"SEPA Bank Transfer","paymentMethodData":"Ab02b4c0!BQABAgBzYbCACvYN8F4OSxYlOtPC4ad4Ei7HCFdr0P2mSIdhX0Dl1ncNiKMZ6D7hynZq1IixoecALYJLKLynjW+GJOxzMzjLI+MA+7LwVWkCDP0iHnpLgJUzp2g4sOwr9TGZxz86VMzJ+LhfOU74tQnyF5QeFf1KT0vGRQGhYMLRsZ7ZMleWxglma8WDdFkakYzD4mLHmhYsKORTNC6wsBPUewd+NbZkEA++ajIcTdH4NWR088EyewAWij2WXxvvtE5Hzh7iEAqoCUNXcWeb0WkeHTYXOU3m7iXH8y18cxz\/ioTYmICcpG3tX8uvWmmhiZNFh0ZD8+pFcrWJAz5xmBHa3bCtLuf2Dra6NuD6DZ9i\/bIg8jBJ+Oxe7EVwIxuPMWJDI1evntEmreLWMS7ryEDHjwanCLNv1rzSypBlZIhiJy6WxlvjIjekqjFMbVJYnJNRoJolMSyOAm+qE2ftM\/e6ZmN3FfLlGLpqRIG7m0Q2J1muiJBv+A5FLAJ5G9gjVJvDE4iEI8pLbX42UlFmRMRAcCKNuVsilf8bW3a+Dx\/T2XuLdFE3jTs5KiQM89NVukVfIR0BJi\/YMZdGqQuXNxGA8YxbHz5T7XQfuCHgHsiaWvGfgn3X4ozTyddCfjguIJ0pOfDi3rUwjK2uH0eBwzTE7798AiVcjC52zUEtpZ6fDgKWRBCEudgGtV4Vzs+CPIpRNaY4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbOWG7Ib98uBx5r9C4Ki1MOyP6skIdgfqL0LR\/tMyQrnQjHGUVCNi\/tWuaF0ubq\/EGOUWRvN4dER4iQiHg4=","type":"bankTransfer_IBAN"},{"name":"Bloemen Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBYEjHQXHsPQ53zYpWNyDvC7SNlrLLaAhQpjEYQk8PPmdaazLV89dowf+a+xepP8tHOTUwzobDVj\/KU776tP57HmcE4gjsUikDXEfiV4\/CSmp6wszy+IKktTTQJ\/iztld7+uvlAtRw1mVPWofaA+B7faxcxduC1jZpi+Sx7ciKHQylGvUmSe9saoz+Z8VyyldP+K0RSzC2+Pw8CyKraL169mDUXW\/5FNNb4Ig8HRVSX\/5Lhi+xIckSNej3wWE5WBRcnzX0PUVKVK8iMO0RPVNmmBAu3egsDKf84F8YQJ08sYEupa1orFHzvVm9JkHzca1zjKD9nMA0rv4AKaglpy\/j85hPLBRMvBEXdJRk8FDojP4C7cXg4yxLz6YbqT5jOB4hd9E0xBfyRl6T6v7XV8vzXA\/XyMsQpH8F7q9kddAIobfNlxSrwqRmR63zPIXuXOudMinxlH5B3F3RHmG5s7Iux6wLE0vrfEJb7T46vn\/+ec6q6Xz\/ubFsE10ZffvIyEM45Nn4BvsgvnL+33zNryl3LEA7ZYCLczmtO16jkxPa5ef1ncYn6+nwPaytmABtJWV5LGAlnoCB8llP8lxDWFQmccCymO5C5KqT27Lirlwr2+9ea7mb2k2mpIqrkbA2oW06GXJ8vGrXHlZ4vRtxXiJM1SXNiU40tfjsY56dYTwh2ZRDooipnPrgBrgDtwnESO1YZAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVq4UMZnNJzezmTRqBzy+ZUCi\/kgQ8pLf\/wuWIkt+XYuYdBNjzZ4wgivSU5\/ixwXRr6OIqRmnfLVJQyQkwc=","type":"bloemengiftcard"},{"name":"Boekenbon Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhXa21F4rgq1PNi+V9vpr6buE7fMZ2vfXfklIHs9yLO0UwaEBLxDY1aLRDkrCoPX\/zixxQ0J+iM7WJMaRPj9Lo86q+oee4UJt1q3lc22KKlrOwWSsMAWQ4EvtFexyITl8jOqfSzstprJDMC6a6cmD\/Uuu1\/9u+EucT9hLzor7uTpvEB+qQdWhVOXkIbi3XgKuzHkZFZWC\/cXmeuvihyaFdS2E5N77AfElpwTUjjkSWdhuTT4YpEKvV7eGNcb4tknPkhtW7XNXBjOeFecLNJVRSPPs8zh25nibZ0LESEAxUVQI+Ix2aqT0\/YARhZsKWVkf7yW24eP5uLO+3XcmI8GBHyd7ysSDU5RkRBcieId7sBI1nLxmxgA\/4E0YRg3kcN0l\/ejyLKhndPshLpcbJsdQdupQtGj2wvK9iXk5PqxlgY8xmI73DrFI8Hj5KYq5BmT6C17J7Klu0olLa2tQPkq3y3jYgDc+UhuCjLESVt3rEe8LGdKyVg1NiJxJV2iF+wqONs6FJBMKh\/Dt8uMkt528lRWkcsPA0kC182YEYzjMFnWMs1NaSemtwEd2gOvNJbANxduIawfrXA+tmD5Vk6NnMcWfO22hlGu8Ov\/A2d1BrBa1210OPxWi5h36f4xOvCJZB1kZrF\/8LbwDNthGuIOUoFzX4s+h1jYGnG01K3unmaRAUMYsabp4L2sw5MU9ZtPpRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaO8DXOTDuEp12ZTJ17xsc8hPNMSd2fEMNY5K\/Bq2ZHktR+J1Sip6zl3AMAQJDedPMUNKhYJpRg=","type":"boekenbon"},{"name":"Cash-Ticket","paymentMethodData":"Ab02b4c0!BQABAgBsZiHDR0Gve3zcnmYtLxMOTZLS4VF3wWqCwdtspiwJYi954c0akftgKzKMMcXoFRXDPZpqJ1DeBbkZ5eKjZzRWnjliE8fjO0PBANuflbRoNwyHe+eVa+0rlve03uaZQp4VO66WjFLS\/YulZ1AJGGyhka3MVkhsE8AWdJeSADCTKFVJA8qC1lBJjaB\/eLA8EHerqPxHYpi4s+ykFMsfipRHP9pIk+5xULE+S6NtTmNVT9JWsD6F+hbDFm6BOtrUnEKx3FmlZSYMY4n9CT3paF0sH2pNqJ0PZ9QgIzO21pb9BhCBt+1rXjLNXp82kOzBI3YRVdRGCeSQ2Rp69ycAGhLikftZ1fwRITnrMfjtEhgdS1qbIiEsAhyB1GIBa09755Z199U4QINvMIhrFb49G1YOsPyBXMyzQHgEAUxY7L1H5CwLDo6skb2LzrseaoKXfF4BoqfESoFiRbnI\/OcD0nh6+jFswHIPXJcCRIhfPqu\/pvnHNs+TpWzJgwQTyPy1C2k3D0e5gH1I4gcn46xYpZ8IccL3U53CIIFFLaVwjn\/wUackQO++SixCiW2A0ot5tS+TVQs9w8QrVWKLLiqTSuErcmgyTi36Q0\/hwJc8YCuMzSEYiNxk2wxHTdlHG4\/W21a6EMp+SnCWQnotauR35c6nH7frYHw9x14\/UJ8RY6eG+xB4fN\/KW526zbNgJPLk4fAmAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifT8y+YkU4\/u8F9ki4mg7yPxc9sfwIjQ+eYihenv6i51RTsNjHTECoPrQzMH45WT6euh08tXFLEmE","type":"cashticket"},{"name":"Chasin Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAUCPrmfgcg1JzKH99DvGr8BkpD8H76IJa5X7CQlnRCC4ZWxLbr6sC7WQbYhQjZQ0lYdTMisYPl+8QjAEPr1N6OGsWSbofrBhc8oNe6Q5\/kaJkHW5JFqUgMjnun+jSDRNSyuLOdsPgOV9BcKOYwiehV7v8dvtmS3KW\/l0TMgwHEn4V6bixIsDkEPd7uNX5p9ubVmiKQW7qry4vXq+OFbbxIWuq\/L9FawvKcYbqFjgwgsdZlQ+Y5zmlaDSQ1hfV9Lfo44Ph3vXD7Evyt1PKrmrifi8hcDeKQfW66kBulfIxesI\/MS2C13Z8cD+WutVG0rbD0uc5cxttm89mjvZrBez9QqTLH3MBK31WD25UzXKRk8C25Jdb6iwxR5NTDrRFQwfBgtBdFSpv3jhd3\/LCj5ycPkVSNOKQUpiT0GIBNJ4f7uxY8+vTGfcSjF5jz4kqI8Xgr++1vFAKCN0KMqEoePGxPIeTszSCKZjptZioNxeR7uU0wvaH18iqZlUmKy5K8r00fZAkxC8aFZOuKSx7JDdzcx7Rbv+4fBiLrwFXLsN5Nuksm0WIQE7zi6J67SGXtlrXo\/bpnp1duZzJ43KmWZYljglXd\/l2usrIYC08dqEwc4DUHKHVfiYzZbzbW+JsakB5bU7iXkJyO0mQZ\/pC6fnVogb4bo8colc2fpM5OD5lnhRDeFz6l0F+msrFfX9vv24wkAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXSVD7Xq\/yT9JnfU4nQiMdrcf2pE45Hp0ed6hMf7e9Tg+uY\/f2i70QpL3dxpumUcnd9zDUWTOJc8ddqXfQ==","type":"chasingiftcard"},{"name":"ClickandBuy","paymentMethodData":"Ab02b4c0!BQABAgCpjBOy6+XhVNGcD3XQkmoZdhv9fam307qmGdDkdieV5c7BN+QZHV2XF8AzgRmmUwTtHGgCvxIA7iIaDihSypB5XjC9NFu1CDwFs5zfPS09kuiZxgQXm9anvVlUgDy7l001y+n4maQtgXhN5olaUMEQ93QWg2WKeLbAzbE1+hebus8bcjAcp300TfIwSD6pztJxjQfwRvNzLrhRgszRipi8ruiGMI206YxJUq5yjpV6cut8MgMfioh3\/\/PLoiVWoCjkrK0R3TjL36fRVwY4XNBslczfEUlHCTnM6jLjjCqyAmNHay3oLv93k\/UxaJoUo9iMzFm7gu+NM6V\/eruSvj28dypv+UN+4JAs1PIOeihxOQxI56Zv+jKTO8GKL2VDOeXkBNy0gQmm0B1+vyDUGSV5Imc\/Ykafk4qgXPXG0tz1LH1UHgu+bh9qr63zFpilRpiu8OkoMqHa8CkqyrYG+Au9Ql5Vfh3ZJS9RF9mu1llY2AvNdoue75rdglD6kJop2ng\/8PO8vUSt29Cdemamtct8zQXd5qwC5jukW3+93brD34tTdKdi9dlpQa\/Tcla9vwVwxEerqjiSKx\/grl+R6ojktZXT+tpo5Aeey85EmlM5L9\/CstOQDjA\/hU\/D+iixa8z8vlrGGUisSOn5Fqu3n85ib1KGW+RHNQAJu6u4ZRBCLhDUHY5qNmGJtD9K\/pvyP1fsAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSFcmmFsCSPTa+2JtLxC3d9MEWXmttbt85uKKpUnwwo3MD1lgu30j46g51TaVETPNu63LZYeC94=","type":"clickandbuy"},{"name":"Costes Giftcard","paymentMethodData":"Ab02b4c0!BQABAgB5dh0e0SvTSdZSqNYMMXtGSsTlyg4chLnvV01NpL+W7I9Mz\/KgwXYe+LYuP2yGoM6TAzQacDclI3AAnXAQJi7+5ay\/j\/a0\/m9ViKjmMcsO5f8S3mlxVApyIp1lKQod1QRWdnfGi2jsbq2DQ2hOa2WnU5gOofDPN\/ObZBAhZK3FyABfJvQ+mHMQ3yzAV6UMxPKR8VRRVBr3qexpeNsaSnT46JpijJUU4B1FAJUsIzivvDSzBcXzBNI\/9EKQbA8wbLb8VGVwKBHun5rPB5jD1uCRjvt7d0XuA6hNZiJ8yMU8Zv4yDc\/YmTEStNzZmy+ZjSZOHWKOzoyCDjfICJn3RnvhWJJDNLfbZ\/9KQV8NcPm6Mpm0fCjf152UZ9YMp2nKhGZhnijz+XLGkzUfAokrJB9d+e2EmiMa4CRubW\/gwFrg0yWK3cUV6+FsJT0NyTKkhv5\/k5paDvp1GF3JvIwXPJzpUEkYTolCXBeld+2YNcdjvVEWC6+YC+XJofqSjs+EanKcoG2giz6QXv9ESYwIOLQC7TcxHhwvJu7n0qEPWWvKUdYnxW57ZZKyZeAlwlZ3l6nNwv7d2cvEwxWI\/MSf0dqgN0mvNJTxpEpDb7Uv88IdA1QHBzl8y5Rfn\/XT88yXj21BN2wvqAnvCoU22FgtK41Ti6HBsRRakXeaakmilJf0HxDWh+wexHnojtqXGWZgQZxlAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQ6kqwSa+fIsdB1ujIQB3U3EgrGldRb622nuP5vCg9vZM5Md2djfmnYIK8poj1WQO4\/+ZpLTzxrPFYbk2Q==","type":"costesgiftcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"ExpressPay","paymentMethodData":"Ab02b4c0!BQABAgAlRhg2\/ZqSemwr8Ih+EPOdyII2d0Fqd+vxWEbnLhm8aTFGk5cJ7BXwBvNvp7+kSkK2+u61SeKzbYlwk8wZZeLW9ZnSvtFocxEHYriAwg0V6feWhMFlVNwvMwqZ\/649y+eA6KEX0eCxNJLJgGfzmgyX2IN3R7SEBzXoidFDI\/Bu9L1L0oTn3Yjq9zGjrgmlPBUV9CULM5bexH6atWZJoXvQdaUzEh6TOGGTY6myFl1UEVk5+tGP8imnzpAiN1NEGuAzRawNh4yhfkPpQ0Cjm2CNFCri4+A3x+23jXkRFSJtCsZIyl6AeXtbDdBEwnRk9XO0GCxqTwvoqMT1mIp8tr9w0VSiUQfO1YHrky\/N1DLjkWuAmuZkW8rkgO3XVhwrtclmH8+yVhj0Vo9NmrJIQ9I6Iqxco5+368N8plzUCseAlWMmihdlSjOJtQ2bhnBCJR2A+1KSYk92bAccae2WQMWU2cbKZxUIIO9IdvendoaLzXj\/OvpMw3H6OvSbzW+Z6BFK1izrNRilrUyPOG5yL\/bnmpHJt4ueoX22JvnYCQ4KOBa2Lj6EUFyQbZbyv16r5bTEqX8ksZqVpLnSHhvyx5kFcFm7h29\/+GzZ8i\/Zi+1W121GBt38+ZmmNTx4iwRRPQ7zcp238cPnxarzHOLpWHmr42VKrU8ra3wi9i2AoQhd0hAQ6gXAx5EsYBBos\/TzRTbOAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUtH0xd+yU6FqhdjryMG483NbCa8oLdhRm9Q9uNTwIBmqqaCWfAUrVW5+IIq37DYV30=","type":"cup"},{"name":"custom_settlement","paymentMethodData":"Ab02b4c0!BQABAgCT\/yAsGsICPsYIG7hiOwZ5D+b1O9G+K7GfQfbJrYmfFVPbjSqh\/XaKdZa+1mTi5BKwuUAV\/VlOPkPQ5yHLS9X6DqB8YqJVSeWEC6HsfX31\/ANJ7ZcL4HFhVq3RM6D0b\/V3iX4DoOQ8yHqPy\/bNHYxaiF43psUHdBjWsQyFVlkVhf4JhC4fJdPlOacag5twyZHDtWM8Qx802T3GFWUjJ6U04I0AigUBTMQH6BbkthtMnCXsoie5+vbWndD73v8luguHw\/5wh5ebwwsgmbVLzi0\/7OITS96hiAQqR2u8dBSBYKhX4G3zfJhmNJyp1g2z5BU7tJp\/IYU+LSDqkQJnmUeFhQGt2wAFIgFqjIqTrFDzYDXiwb2U2jygr8v2TzGbt\/hTTknv\/xVSAzU5DzADJs8\/nv7l0uP5XWAEFXfI7wuUHxBTySlIWPAH\/+uoyhu+QLfAT1jLW4srNTPgMnFlgiuSRVi\/KGPAlN4HO2O5bxWxUZ\/136Ak8El7\/BMzR8tjPRG7OUjZp+4ehhCXNeeBH\/OJ\/FykNuysKSklhbOE7Tg+N0pNZ\/fiEOgCh0OWam8FOrtLNO9LZ\/M3HJiFYnOT8jdHp9dvUIIZ9758N\/jG+EZrVwNL0bfH0thO+GhTKCPsfcO3J6rTYdOpW8zMijfLk+KCjVQxTD6oc27Ha23Nm6gfNhAPV\/w+Ptb9f4WcmQyqTuGFAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifR75XW+jn7EcYM0F6+owXDrbhi+60k1z1wlKr27vIyAzr8U91Jm14Q7EzlL9zrlbXd7OzeMVjbAOCdHxJa2MXA==","type":"custom_settlement"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Diners Club","paymentMethodData":"Ab02b4c0!BQABAgAo7InmjrgFwmA7lm1eSiENy0cDe92QK9eCftyZ0MRsSqugGYF0kNdG8LCw92FLceMnnljTGM5hhmlTnhUlBESSfbSOLf8d4ECCcc2W4gVCNoOxccHzoQOFnumjwK7\/Nw2F8gXIApCxRUCnzbZdPdXbwoJRaak5KOIkmgStEOBAoikvxvcckvOsP5K84tK6QlyavL7pXDSVIcwsiyKoxzW47wjC04ti7D+DkPqBb7pzhcx8Fu4c\/28AhXtinNMPLtDPjDFA4wkLHvVuUBTEiRy27x5wcDWbHOVEMnP5yqKmJuD7Msad09y9QxJPgn9u9SlbP83ZxPRNFD1jjx3z0ftrQ\/8Gu2e\/BQ1ib1ES1eR7nOG08r5aZ8LrkJMdbuxYK5EObCAv1LKaiJNN0EursZsq+0lLR3I6NdtvxlICrimCYS2pB2vNXohDF8Q6gfcFZgAp8fH7qVmMPnokuP4I947gbDTd\/gH\/sx5fxUVN9oRQWCmhN\/6y16wMCW9DV4vXvE1zUaTNDM4E1Exihr19UKyifA\/DrNKgfBE63SSav8nT1v3N46GZbR8XfXs0R6iad7nxgcrX978op4fRt2tt8wciszulAoDQp2xXCAFTcs39mBqBE28zh97wD2tv2ml4SjWU2HJfXwX0wYUAZdbc5M0e9a1RqLwM5blEx7veR5SaUxA0Z5dML95Lu0GjdnDyrTbQAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRjz1jnjq8n1nAh9RGubBrWwPJjLS7IhRac9SzrYauDeqPcken4Am0XpvzzJJ6O42bAUYmM=","type":"diners"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Discover","paymentMethodData":"Ab02b4c0!BQABAgBYFaiKDD9t3ppHHM12pcphfSfkzj5XQmBKyHFyTgXmRwgM5DCf5p\/qm83HJ0Rwv8++3VkytEGkW5ezjx7niA\/R7XRGPC4JFe5m9BkNUad4OJJKn38246IX5\/tCTC50aazjLDSRAYDfOFwjCK3iCy3jZdbHjsayq3Sxk0uektVCAfGvgOtgFRu\/qbKxfHYX5JhRhRD0kLHqoPy++r1qFoa9ZCAeItPwOOIiOh6y5sIS0egka\/z35JFIpmPgZA3T0F6C4+1\/33Lqf\/Imxxa1WbxxOK+hRFk9xKO8vWA+QLhsNKiGBDdwrrP1IBZu2\/3GRl4c4vTt\/aTfzBMsYEAEhxYKvdpm+HLv1uvY62FP9VzZc7+G6tLgzhELi3Ugk9b0cqW2QkQa3GjRc9oyCmlxpTg3aN3HW2WcDLNH5obGAeI\/KV320zNx6Dcp4QHfJqFhajbiH0kJpM0f14PJFqFIvkjryq\/3xx4rq4VWTvNYbsQfdkjmjxdpuZA2lVFbM7FWlfr6dujmw2\/k+Nc\/LNKocXLPMFqNsAE5sgnBCiaudtBhzMn\/Jqg11uuejX7PwuvhkH2IDe+C941niVbdJwATT5s+rc5MU0ve8lYbannglu7vLpa8Ay+dbViS5zyPTCYAYOhP4hUVPb4ISDJfMjaZ+7HHvTmBbp9+xGlrIOUshG8qkhA+h2IWHVsMFvPKmfBZSrlpAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZEDk1OhXuh02mODttzWBOOFbwWhn5U5VBlnQZ4pzEFgfDteYqOogaJ1hfiz5hC3ciAefezhAg==","type":"discover"},{"name":"eft_directdebit_CA","paymentMethodData":"Ab02b4c0!BQABAgACkXJYEWEQVGc1cvYHr\/PEToWbECDcX2D2SEXBnZpMLh9pCFet2Grp6Qm8BbRvR4o4eqXB2Fbf8dgp+PlOYeVpF2B1sKriv56YOW4+eJOx93BQuvFjhqcDAdnuA1WEd2c0p0VRzd92CLVEdAMeSJZf4+IenTJ1xqKgJUq8AEKB1N4F6LLKMHJzgnNKsimyLitKgW6DVprbambfKXL7jDNK0WrHo\/9OUBJ31eIXTFPWOV7COwv+22ZpRn+mnkRFmNP4OoO6LfgloHwMY4ZoVWrbFFt7UTDJw4HAwJaEiOMjH+prjEevGqKheo75HxpsmmwRic+P0DJkjh\/7LiNJuKAOQC3EafrRCnErTJ7lglYN2e2g06KsFTgPFI80mBm44\/5MDp2arnowl\/9kxyRuY2EOcVkmZkHtN+PCqdmHPdkKGG43IC8E2bMgBaKJzLr\/TL5oEB80fEw2MAd3IJMzn4Wec9Ihtp4goBH\/5svLh8MWGcqZZQH80VbdKJ40cWNqw7yscqttDHu8+DWERqpYpkV+vORLsZeFTAb3o5S\/9RHIzB02easuTBrVKHyVXdHmSH56J6Zj92Hqjz11ZWR8JVHkYW6DGqvS0nHI6iQfyr1gGOlSGAl8TZqr9tXm57lmSWc1PV37\/y2EW+xY\/PFWFx9rg6z+pZE+LiZpFGe+BKt5GhCOMWe2GSvn0bSAVwiQI4dCAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUDGPWwpG\/h8MJ8mwupRlOeOI6M86\/yxnR0wEHs0UxONfu6RZ805+qkbIM2J0P4I7gmdMlLPcnsCro4LatrBrF0=","type":"eft_directdebit_CA"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"eftpos_australia","paymentMethodData":"Ab02b4c0!BQABAgCvuSe+6o1SUzzcHzxwAVlkmC3SOJcaaj6IK3hGWSkfHMN7VTgEOJRSZefRN7PZMGF9BK2M\/\/wa7QZNERXeqPk\/DokBPZtA7Jir1ANKZB3Ls6EHKUMZvGviRVMt6yvg5RYkbP02\/CG90SYL1gZW66R7bB3o+7RM60\/+HCCIVMcgLmn3jIV\/D9DoL4lZ9Rdm\/FIVBXzxzhmXzx9FWGO+IjwzadF655idJkV9Fs\/nwE+nGyN8sM\/nYBzKMYYW1XxsvR8JYKqk1XbAbDf+euXRVNXiWmdNnTl5MPGXIwt\/D5CmVAZNPhcP179wX63QaC+3AG0eZhyn5Tm9sm3Rt9IMsnkexBYd9hSmSKp1nkq5mgK3R6QQJVs8yexWIndiseKpX6ejl24gp8iVHa4R3io1lBO2GbId\/EDhCzqjVspmT5089REa8DMC6HBVBnFROw26tt52NPDz5Ga752xSS2dV14gXDPpij\/qqXVkz\/rgESVzoBSvt2irWBr8tR8Xnl9XJOb\/M5MQcgfv4PlYeTCc\/iTPuj0e+GYzKOA7bsxmUrewVakmyUtWTAo0umEQn5ttzxl6Ro\/PYX6MlJ9TM9tVmPMIgV8pXg7sETJ5SZ1enW0FWbcuVq+UAkeHllhc0qnuYEXYQxChlsER8Eo3PNcLLGNHIBaMlSrxtHKx0ttsSmPMAuRBHV7wp6ZHBYoexL19bfn8gAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbcE2OmagQwrIkRbuPym64f+o\/YlUEAjA9iyzKP9zwogk+kpCbBuJ966fwwr3DOkqOQG5j9IojoMnyfGrTn\/","type":"eftpos_australia"},{"name":"Nationale Entertainment Card","paymentMethodData":"Ab02b4c0!BQABAgCjeMTCCWbyHkLqIzi6WhOIs0cfGy8ohqynOFAchP5uknx5zoGGlmnn1yNW1wootHnZoQ+DC2FGnBcok++A6EK9tpAPzDj2a15ZmCjxV\/SkQVnywWvRfL49xQsq0vfQSYKu07PVMT2Y0GWilXW5LCJEoV9Nj0AAaO05iTTwuuI\/LiBYwSLcJY0Gy\/nQoVCGmi0HRBS\/lgFzlZb5JH3f77SbbBDkHGuQzK6XR8qxGP5lU07G4pwJ2rlBHddEYTtemdJVS2j7SU\/5auXz0PCkgsgAV7CoHNbclYsL6FF9ZRJbWyDO1QpodnY6ySo3MqSuhSR+v2sJxqIYS6MNwiYbJPJj9Lnf7ZY158z1v9YfM+XLZEB1gt0Pu8TqSTJr1509zavS+5wefj2nm5HFW98Dho3dXJ9p76OT6N44+j5yn5B5bGuhSainoQkIEJwc5JM3Wiu1ZVgNLYT3wMqHyIEVArQh8hZlISVuZphxnUj6w90IVBnUo3cMUCLegjeFoBZEYHi0j9mGqMVgyTL5bi3wPH7nhIYuXk+LZlCcGPPMWbyr5ebLTPM4F2aDNdFZ6WtXkBVOZT37P27nNFXVw3ZY1T6ZhHV4\/NipJqWUTQwJ7bkf9qAym7aoZc7AyoyTKM6yDF42xKK7xU+FgNEolMBJSofshvnlbSsj0Fm\/PRD0NxGulBBiNC+IiUig22Rsx\/VYfF9mAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRG\/RN0dnQzhDj7uZ2fEMdkGldletkPTAybC8wYB6LLM45oVYPELjZX7YUjBzaoZ+cxKhMqGOfm+s+xh4pM=","type":"entertainmentcard"},{"name":"Expert Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgCTszJcLXT+uJxGttigZblCmXk1gAX20z37AeDCztrSgfBe1Aqnik7RXJPua6aFQhmwOdeeffC51Q54RTppmkaFAYn2+j7SDko0dSRbIvbh7n2do3rYWF+TYDtoa0Ebfbg+sbbjgJ8yXtv\/OohsN4uR3eUQWaDYkv7QjX3jDP4h\/V2QhvRYzOf9CY0qWx9rFmMyG97+Ck5vltpQHXAAjFaEZUAjJ9G4grUuWByViFBtfqcauN7a\/uZ2yaf11giCm96Yju27Je8whJiKgkq3jq1HrEx7nx1nqF6vS1z5JqypRsvXZpw2o6Aw7l9N5KSX5GEK+DGtf\/5o2X\/OPzakj7JqRIBd4\/czCVDpX2d1rh1F8USTEBOyTmAmJHMldg4PaVPTJnOQkXZQLEQU0fR058QDmUKQ5X6sO\/ssL6uK4HxP9iNrYl9ZjERiFwEYdJI3NZq8Kf5mcKtlgxYBSZvwlud2WDv5NNT\/OlRRrCJ8DfO8oykgRArtCO1gaFdhguaT9qWj+2l84JhrldUVdJbTgZtPzdC+RaMkxsEKENWIaPFSr7J8xyqj6sI9KO4Z0v8qtp0Xndy\/3LfEFJW7d94iEbg1vfJhDrp+rDDxbN1ufswcvELiv31DuBPyj3zYCDdruuGtfBa06jCR5Zed\/xdDqQEYzFTvw+mKVx30D67l0Pnx6hDHUvryfFE+T8FuaEkViKnXAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVmg8HpFTq3+PEOZ0boCkxR5E4l3XlAHYC7o2QP\/gU+cOf\/RLlNEd3pwMgpFrA+qq+LCSa71oCs6WKAd1w==","type":"expertgiftcard"},{"name":"FijnCadeau","paymentMethodData":"Ab02b4c0!BQABAgCyjxcgXJ20YmmZzakseod5p2QVS\/6zXRowLF1QOY8MLodRhKc\/tKFwqfUNmdsNe4OnZgoUZnUzqadPdnqGy1ermdQfv2Rfb5ZNttW4WvC6aVxFlTlCOFWM9UtWgH0O3sIc56Pwu3oCoi4F95rUq5IjTk8HuDV+CJPWjKVME\/1r6WgKTDK3CgIRlQ5pJ9gW1Jr44oGendVJXXX7bgvZAw4FXukcEytJdeFw9vW4BU\/mwYYRwhLx4ryq7NDTFTEtLQa9JMEtUl+BaLSgynKr+ChnH3CzrZHidRGv+oP2naYHDAMd4HGjq5+mjsHeuzM2mdAq9CQ7qWFBJRemYIpJ0k+9dCA9IAquQCCLn0tbdRO2L7m\/k0K1NxDttxBKWD8ZnM5tayyf393Thu4sVMaRKyqhnlYtyDikzAr20hCXQImmLmD0eZeQBJGqXzUCGm49byy0sXgDnvZ9V8PUXzWPFUDjca4g2FBrmwx3PZQKnyNxwr+YrrQTcwE6wNZDLb82v5Y0Msnw1vXENZHMyZ5MmiPG\/+cBGLmnr4\/X1YtOyz6ZCcS9I5qhJqohrRtxN+WyEwCeljjxydpF3iJA1wPeqT\/UIAq8OojvB0Uqo52opFDwExq7c87BBeQAGFVqd0FW4MV9ck8Rp3sAm4aQY2D5xanUoDtEI+2XnjG0w6Vh9wRMiBC9vi0Yly6XkwKihOxep5PNAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYs7Vz2paAGqPnXyXBtOMrU96V8rY+5icpFu1YXSvneWrazsOO3N+y3WudVeU9mQFVBlSFG1Uf6p","type":"fijncadeau"},{"name":"Fleurop Bloemenbon","paymentMethodData":"Ab02b4c0!BQABAgBXZOsuynZasy3ejqMVaJHj7rBBmxTdB+1QljXleun\/eQHtLB2w+r\/MOqEboTzAdLrYu\/gCLuWS2O7jI3+4ZevHWmx3KA0pNNZ9q1CNM6tLHwQ0nsGwDM1buTG+g5tRULY13M44YZU9o0QWnwlbm\/DmxAYtyAKIufwD\/TuXHVOhs+lj+UWcamJpnLJ3OqwgXuHwBWkwZ9ARn1\/sBAlVKYY\/Po82mKrmaly7Go9pJR2pS2ENvV6jYTSicPP6NI6tYnuddgk3T\/APxohNK+qcrx7La3riSRl92kK59\/7irgcuEqcEZEWX0zzlrjxPzzwlxS2PxRRzltnKyDLs6hz9PPtT9rZgiYyh\/VnPzIFxQklf+iqc7amV5WjiDOhKz2J\/tpYKMCLcbyIsKU\/TmLFORiurCwU5MtLWaIUG+MqulDKPNlGtwt9jYLWokXNHxTuWsff1M3FKJc3ofqtrbSChr07SoEX9aZDa1m8e91O6MA0qOsR2GbUsDUHdZyXOx7\/V0pesmC2UGjGZByJx6dCMeF0Fvf822YZL1otxGRLB4HLgSkXXSKv1XFN9GsX6dFarF6iO2SPhkcVJLUgdVmWvh6iQHD+5rw4E9dUNsxWgscCrO3+CUoZshg13yrCaNFD4nzHNtz+Zf01s0PawpD8ZwSjq1NrCvCbmiFrFiYEtiB3d4RAnrZSlH5YDLXTgqosLfWT3AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbOO2439Q9BfQ3ByJJMSwrJDvT6Sy1M+0bSVhmsqr6Rs+TmOr5pAZ3F11J+22AO0aSk4sLHTWO+GpqIMQP3oGg==","type":"fleuropbloemenbon"},{"name":"Gall & Gall","paymentMethodData":"Ab02b4c0!BQABAgAg7QkV+4kn1vULBkb4lRhi7bw0dRiZidC4vqbaHqkPPi1obPM6TJu\/twpWYhMLYppfvscQ56oUQThyN07N7\/lbwZGgoV6tgFtd7ZBtrgqJPPoVM8sdLBmRLC6nBU3d3U7Xu4SvtlX2JQmxj6t4g0zcgUqNhaLlMjxQ5cnMmbWz0hZ0ustLX1biM5gk7FGDW5\/e73vNgb\/rAkfQRPBWfbGLEC+n0+QBalDuSeVZs3XNdAp58mhchviEmIppKQMP5c+ZsCLyeqGYM9ROAv6QUbtXUKFihruXQDLkqPJABIReTpujZFxqV0N7mMyJbEeh7ikSXKqjQmqqtVZt+wciVz5kcWR1k27K\/3WV1Vy9HNT3Pr5Dda6u0KKm\/G6lf1oj05yaozEJhJkgdrJ8lrSe10oFfCEroNoj7bSx4xBoA8IKZ1F7jqzbRRCgbFak2OBgbOo155Hc3mQAxtgZ9teycjMfKAjo3xblhQuqObQURMp33pbvlCL+3ToUifz5ehydevrHLDYZK\/AA7sv44AiJAy6W+mgfFifXJM3+XasVBNz\/oto\/stjymaFMVVXEqpaYiWOKsOmoyqNk5mHMM5ZFFrfz8lFwojkkjOlQWCI6d8+PeRlGp9dW8wmKOvFJG+RpPmYj3c1SwdGT0pevQo91hZBB46Ypn5KXyvSg\/t4vatLrvRBaXqwwvCMKwYwTA\/HlsYSUAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifW\/eRKmjw8uoaWKOBol+hsc8L\/WyVZIIi3NlOa2q0DCbXCje31jkFLJqHJ3ls3mBT\/A6ew==","type":"gallgall"},{"name":"Generic GiftCard","paymentMethodData":"Ab02b4c0!BQABAgBHMmxoZXymjsUwaJug\/qfoTG4VC5Fm1vVTvBgFQDsUodpLkylC+O1zyY3Zu\/MhuDQMpm2mSImemAUeBq16uSlEBnJx+oQEdM7sy0DTfXGTaGqpO0MEzP9bBLdHVKvy9IeMXRJKkjTuOStL9BN1z4EOuSJqD9zEENPMBJ254lEMFXCu\/sUQBhYH4Z0qJZRwjtd6AdB1Uc8\/qwGbmntKUHx+Bxjk\/AKKHrmdFlVJ\/2fjavkqJRIc5AuCjwpnDZ\/zUqx4pDHmG\/Y3UItCCFmSZKFFTsPN9\/IFMkYhfKxipzv96eHMJXV7OAdEVhplHHW57gqENbAOcKvgTBzvtxokLtZTIQZNM45yHDBlkXN96T0fU4ZhdI8VmFkTk0kKWtked4o5BxhRhf9YsrG5sby\/XNMCGbXubTlrhdmsg74qSt82GHXyyMK7+1qFI\/WQzMDHcW\/grSllUvBR89MujwbHUrjVgS4Q\/qQNSFet07d53UY3maMspxdpjenYVP\/6OyMcE0SQnR1ZXNHm9OA+TA7NR0IIEFEG4XtdzhuDc8acW2GlEvSxsTWL44IaBY6PRilpdF8U5CJHkPEWC4criLpxeOpkX2ulgdc1WsFSwEJkzZRGdq4WYWkrWaLfVwj9Ihc3ftK2sb9928VKmDMg97gc52T3fh2NSv2uVRZGT4Ay\/wEpnBC8Ev\/q\/COqfzFp9HHO2Wq5AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeuy3dD8N58\/UWJfGCXfFvHmQFj8EV+Ams+QEs4c+dTUH1uLGiS6azxtNi0sZ1numoBF1FsBaTM4VDvsWxI=","type":"genericgiftcard"},{"name":"GiftFor2","paymentMethodData":"Ab02b4c0!BQABAgAVPfvRFY9o0RRAtb+F8c2kYHb+aOlojLUI\/ta\/6uB5W+Y6yFF9vCHY69AhGB32kH6EHHO8bv985AJyaRwgDs4QyzofNDevaz7zDb4ET3Ak+Q3sU2ObO7wTO8TAP+YCTOKgJ3jZaEKt+ExzCC8646uTWRuWQ\/TB7j2p5x4MEt1Gb3k2ehc8608r8oLywYiIQIx1XyuvfRVDHttWcNj+Lza1tRr2QTThFdLRa\/wNfuJPw1\/AYFk7HUzhh4AA89dQzSRYHs+3cglU0VdMvm3NEgvXYpYyNJGhbCfujfUgzX1ZfjHhy1mQP5sySPm5hXxjvF\/6deSM+HaSSZGw1+f5N36sVcrMNYPKMYlh5c6zy2KzdIIhxm+mEIiC5qlCm5Fo+XALpUnVZfuViLPWIvQCIFD\/mQ5b6LLyUQK3IgTvQyHmF2yaLihlgfOHt8gizJDmHOSPMNNPb3mnnmgBeIKvEN3YHl3gY\/P+L0xM6xh0DRo7gQ5PLXPGyF1D00Easx1hm6x3kEF+whefRoM0TI329Lyf9C\/DN7gRBu7tZyl3NNYjPWzU0mJfTdJOsW4tT4lrtvG9drC+6rk3HcPtvlsk5jl5fF1lwPtZ0rxJD3kLaUa3XRh171OaM\/ZiOlwLRoRCjNGUdkDSZg2yhJJiFwbFpGfIAXJpJ1kjxDw\/ScBEVXe6SRDRrvOxx8kRmGFnoWKWjf\/CAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSGXhyjG5k5Fo0wiLcQFquadA\/zmxoSfuiiT\/\/TplQlLn+nMDZbzPA6ly3gwTH1bVLkbgAiQx4QOJ7Y=","type":"giftfor2card"},{"name":"Givex","paymentMethodData":"Ab02b4c0!BQABAgBNifdrYoF8tGus92zPakFFXih5UpuT+eNNHDUxAOZi\/0HgqoH7Rqb1Y7IVQWzFCl54\/gDUokbRjp7KLQftd4eh0w0rKRZt9WF1DL27bGUWZLVtI0NNU9CWllxjV4VBPJmm34Za6BJmMhfQ+zLU+7HN7mVnjIa5ALjWDsJBJL5h8X7oKMA9TzTh1gG1iomGJ3nGGMdZWmNs5S042Fr7Q9mgspFmTV98ZdJAx9nFAQl+yzz9JTqziTobW8TkTOkZFVTBpGJL7JxZjJ7jVBWHoWgmJjWsDSdElxfTexaaFv6AmGO0O7jIEG1\/16vxkEIM+EAWfiK11GRUi7H5R6MA1\/ERdRVv27A2PsG4UliBU4arKzQshHVEjPuE1gqjYlz4lQzBCMlc5Hwxoxlql98l1iXbsx7MHMF0qIL4BeTM5HNGuCXsPF0jSIOU0Izcwsn9qQf\/fBHIYktlXEg8mRUpX4iCFXVJsKtiG2aMniwv+0724iQzTPIrBYctGIBGhIM5nxl3AuCId5ViZoaKj7+Pfw08jZDd9vyFCyiFKRCMF\/eUvjv5dsa7IfVVZGn0GSgggMNpWAnYRwKU\/xfgJ5ZHeNfTFK2jOFCdEnjFK2jmL6bvgFdh5PVR5tDrJOYLRS+4MBKfzxSoUO3BcaWvr6ehHNQuJw0hGW9S9HNObgVAjTVWVRBedGwXUWo6lHDTgcH\/8UbNAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVqIw13EMSch6N9oRAeH6yyfpolZ274j09YkRrdFoi3640E3krm8TOXR6q5PekQ6voGdKQ==","type":"givex"},{"name":"Goldsmiths Card","paymentMethodData":"Ab02b4c0!BQABAgAZbPAxtXPgyy+KpWaluDGh77hrNCi3vdeV4nqg\/XkG2dXutXteYcj5uKLfD\/\/dGP+ZUSolKJ+PrLdpzvAbkO\/JRQIPTBQY6Jswhu6C6vkI+mu6dsD5EABoVO9TiGBrnu\/oJGPUiJF\/uX3hUJU4+o6MiZBoNif12tOa2ZSeTYkxmprOvAwd+JMUJSssSg\/fRJeXJT4iMlobq3w20Myk3feJO0ynR42XAeiyTB6iSPOqqOVTD2XFOh4wMMJWNtJ1Mof2AkqzFtFrPvOYLJLdr7bIKsOKXFhPx4Twb2yDb6eBL2BeRdP9PsYujI3\/B1bUzmDgZhyVflxamQztiWGEYskPBjfbZSK3m1Z0tsHg14trN8JqAR08hw2cblX4eSo9eSPyc2W2lgINHDhY0QOmxHWDoHq\/qjhtbpmEI1owHQBwKMQEm8dj\/lg7v+38TNuLo2cONFP55H8vdG6M1gmruwc5KSfZWxC1wwfO2loy5cPwYDYkvkg9m53oBeIbzotPANzgxJmbciviBtQ+IdAe6W6+DUTd\/erwMT9QVeOP9+cJlngOLvj7Dcnjk7l9x2GQVUwDDUWacql1VK4hEp\/h5h6mpK+N1mDXNl4z4sbWeM7R8OTRvo8WeEcxKgkz3Re79uNmS73Y1\/f5nw6B1o6\/B0sEtMFEXw6jd1F6JNKsR8IhUxDY6liK9\/f931i7fHZqKSQTAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbQFTtA0xTDJ2j7HAvF0qrE3gj1c0plKkK6A\/cQ6jkgBoMXgL\/LjHifQrcbVjFFqXz7tzyLgSuYyY\/xk1w==","type":"goldsmithscard"},{"name":"Hunkemoller Member Card","paymentMethodData":"Ab02b4c0!BQABAgBSDDWiLp4lYErsDSD+XimeV8jVzJB6z25AY37kR\/rtkZg8MHvPfEf9+ryljyYHTPrg5bTUEj6j3Yxc5jd3db8to24UiCdrwBz\/JWRUaCPUIJvFrWOPejthgNdCfttgaqfOdVknMYyU35lKi0a+pHuBvkcpZYxGn7Enm9Y\/n+GHMqjLdsnjM7bkpzTF8NEw0JKxUHwLNKCJrvVpe1wP5s8\/JDpt6E42ne3WgHSKcLgmxsbAExj+CC56Q0NJUgdFULHvbF6a9CGmFvHSvik+DOm\/KhMsWAdWES9qkzEw5Z83R\/pFHEMzX2tW5FoZkNIS32jIc7HSaKwHMF67PmdtzgjjemwtLLNctpTBL9MiSfti4B+XcOEBzA5LKxTyzHBcFZLXCioeakxRvra5b3i6PrkexvHrNOtyRwd+71F0Wp\/E+gzpb1KRJ5pRxC5uHkIiBOkurdcKjPKtXoLgpL48NZYWb74FvMj3W50e0C\/cJAdYRZp7yNf0mCvOhLva2ORkJvmaCr6Jfoik4J\/YA4QrM5WPCil72Ubxw1NBcIdoDAkCDJb1IrjvDryvxK2gk7ebVVd9xwnU2y+u56aYZcJgLKJ4XEalGZ+Cpnbw86q7jI3YQr5KaVfFB9yyhU3ZwshPNI3XQhirD\/ESkn+j87lnZWp7hCmsnc2r33ey2PkQ96jo5xBU+luThZvIVTbVJdH897rVAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXoEjevtwzQTa9rY3bi+w7qKrNij6SQfOT43DEUWmCoS1f+F9aLLZMbCWTN7mLXOkQTMdVI=","type":"hmclub"},{"name":"Phone Payment","paymentMethodData":"Ab02b4c0!BQABAgBiy6A6o1vNm5FJZBNdGlULclQpPMw0UVyk5sTZA8wlFQvdHt+YvXKWzkNf7sv9lgoUqGXIvNxk0K3y\/7lI+EGPuQHu\/RVlz1D26kmLxRp+NnjJy\/m4vxMSy\/38NgBJJcrMoXtUghrcKFf3mQ4MQNyZEJ\/IXBh3y\/E7aEDkfgmsSy7UTfNzhjlLzfBVDtLhXW\/QlJzFrV0iViSrVblHKZEowqICP0QwRJS\/XU2gX1xY038LkXj6s4NpBWJka7mQ5WNsinpRWAGeR+Gl8FCReixI09jziI7eJ7tDln4P4JfJGlLC4C\/pG6xagpVO1hyMcu9+wT99sz0k3QmEzWouAkiQnjMNRubfnyXJC\/wa9AMHrLfH6YkScbmutKASRScHrgd8jCBCEIDQ5jAMbB6ZhaTWGqWdwlIuIbmW0HBt7l\/pEQdVAW3x7PBUQwtZMGXMvdFKR4YAE+Lhsc40G7FUSlzLxLs2bpfMc99JUu14qHncEAdeS8XViEvYyR45ZiUWR9z9Fxwctiqt8KIp5faZNP2QaX97W7ySL\/iJuIZcg1IxjKzRc9ydtoK\/NZyBWJu18ti3ObXPPOsQMGzsndigh2PbCEtvy26PXPsXHlY1O1DHT7w2rBfg3Akf9tG57370a56vO4Lus5LkZvZPmOPINxlpNNxtX6O18XwhYjcPvA9IWRA+BXqR3KbrDCFBfURckh9cAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVwWSTKtbn80e21yXRcWWxceN6SKo4qJNUpQTf4WGz3Caaxo5WU2yKF5C7Y7yImP3pw=","type":"ivr"},{"name":"Landline phone","paymentMethodData":"Ab02b4c0!BQABAgAVIhc82ur8irH+\/b2ZtfjOmtNeh68KXn3JN3HpG68Ag+HcU5+J9Kn1\/Vv4YR1K1RgSBCBSiB+o7JHhD26pdHIvhywtz6tqltLZAoEmETfSvoWgcPIzXY1JtohNQ0tFbWIDq6jyMh+xCqheiSlQL6CEdpGgcSFRb4D\/J0mjMZ2nEgcuYkyt0UpEMyiJXYcRac\/9GHql8xfEPAVBKD\/XjGUtz6Ya1tnd71\/6mnBbY9Dlw9nK+Q7Lrj8gz6VrQi\/5sDV5bqNENK9A7jovi6uameBvBzlVfwyt33q+qxnNr6wcE1J9VLWhdB\/YKfexye3C0z\/w0wP1J9a8SFdHjd5T2m4rLkqav+Kxrd9UsCEatXZtfOrq6HULAw\/fVkzJ9U9cvlU5pronnEb5hrWhGePaXU84Ytl3OZguqcSff8Ua\/wI+9bhKRO9eW\/Aeqf1JWSjs52jO04Paw63GTTM\/mXQcENbJfqqk3xEATTUNMVDlSgZEPrytAU4ao+LZJ77tZEnHdjlcRfIcWjaHEtr40b3BhEAc8vCSMbOeBzES81VSH4Fq1W+LR3J7k\/xkcsfeHluXGVKypmyoOLNCzagejubPCQVKVp3jZjiPUh29U\/+q2\/aOy0hoivRNgo6sojwU1xke9JyJE5oxDH+WTbmCsbK+OrJJqcCdCuWbsiY73v45Cx98cBB3wEK5i1rH3AxPiliiqy\/YAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffRSu64ZrMMuTmwk6B7cgd93x7q+0WNHKAGNvJnpC6YdyCShju+eNCwNm069YiPS5OvtvM1OxwA=","type":"ivrLandline"},{"name":"Mobile phone","paymentMethodData":"Ab02b4c0!BQABAgCuF64yixDh9VfjK1wPr86Fke6QAVX+FXvop9\/9rekLpDOVhkNEsNGFu9XlPfbVHEOl24l+0IJPlCbm8KauZMjjDZoprnoYk9AfpMQxeXIww4sIOqtFrX69SSBqrOorw\/22c9eB+Ak4jY0QV65EBPEElG3midzeekcMJVlQWk3i9moaZEPoW5APbbXVmR7+JDPPCtxJ1erbdg3ES0kvkJMlcYuSg+ZQee19\/xS+m3o9yCXmDa2V5nUpTIxD\/5Lf8\/Zf9Jn65VgupVm3cEj24ycqWj+mc7cxWFzdp67DJNLAcAMn5NJIxVExPb5MQ0dz6eToHTMUU27eQ7NyIn2jYmrUKZe5oosEuHAyJDAFARWO98j8CCi5BN3Yy26u7AG+cP4JEjRZkP7lNaTM24GpqI6T11A5ec11hfeSx6\/0c5hdhZQNQoZ1OD9g\/+vLRGb8mMi0Ih8K8Ulm072exvb\/1BRrkWWJCPA02IBFW2yzWqa8YCcuFMnDjD2eOHQoG5YZKITbsz\/uN\/9aj7e1ReF\/WKvz8uJHfg5Jd3G2iS4TBNgOgfeOk0rNXb0pO6iLoyaiKsGg+LNz0v+gWu1Z0B6kinjUEWGG6P0649HRCb5a9P9HgteQSMLA1r2I5guRi69O1Pb2EEEzYsGKfF7NzidyapkuIG6zLXAfoQkLazz+9dCtSxAMGYyaEApK6bnOMh4I0fpbAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTRJwnLsgKJqeB97bJOSJbQ9wWOvM5qTns+NZZs2uaRMsnAecuwmWyLuKPbA8IlCHFhqKj9z3+o=","type":"ivrMobile"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"JCB","paymentMethodData":"Ab02b4c0!BQABAgAEMTePvF4CZtCd9jbirjR0AqpOPWFCV25nc9lQzBq6NgJ\/BL8rbsbeYPEEWf7OWrSMdmiFjeJKZN9k6sxPWcb8D6AHgmVDklrKEd6R5qntMY+L4hNs0TP+Qcx1CzZY0zUFgrP4Gp5seRBKKpoxGUkAsBMgIeZRMQMaz4EUzttrZB\/2p1\/AjVVyULyw+mYl2AiRFCzFJ2HwUFAds3W37UNlOHq8QBcy4mGQLoTm6sjlIHpeudZtlkoRLnUhY98plBecpZYZbHiT9JClM0LOXwyoWPr+\/j58RROGfzcsITOPDbevuouswq90IJcxnsEdnbq7KQCminWgaSB5rZv4fGRWSa6zF5X+bBiQixLQD1zqq\/4apvoEoRcicEA5v6WVH3bpXQBhuD73HFVZ0b2grpq8Rq0eGV9EU4QWDB3mnkVaR1BzqE6BC0fR\/9SxAGeluSJn7HVXjuVZ2b\/XamQ0x\/4YHNPW1XtE5PIVOdtXH\/LKvDS1ceg5PtdEZ\/83Xqjx3Y47XZktdKTrzE+myWJnTD1Gzv1\/YN1k\/qOEiGkyqBAy3ympPI5U+Bu0S5xeilum0kjAWQR5bsGF9WsObAVJ4xPhkYt1V7p21td3gVTxww5QFDFkMSK\/6MY+qmk01gRSRIBflK0bntv01YTeG3iDL+MOALbnrY2StMQ3\/qPjJjKXIBBh9Ksfw+AtNheXk6K0CsdtAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifR6qJrtR6YnxrhZIBJsXHJDfTdPVNTDjG\/KdBq93\/LU+m2blUK3nlsH62gxSIeD+228=","type":"jcb"},{"name":"Kado Wereld","paymentMethodData":"Ab02b4c0!BQABAgCVaykYdBYOd9SXZhmtt153kzRwEhOK3aCqzeW7sdic8Byp5+th0EDWafwfIIG7LQLf33UFIsV5InlmAdVAvMkXRt2BAThNLqSwCR1+CZZMOz5okS2dFDKG9rdh1+KDB6frYgRViisaJ6W+bv77l54NnF+A8B1lPjKydCEnv2eN8\/3mi321AjMDqim8IHrdTYl2pE\/\/R6OEt1b1jALkhn+73jt6gXboMPwuQTpkNMRxNRP\/YapLkKX04A3Fzqnbep3BQhXBMf2YEXOjQw4ryVmDIojOpPjhk9eu8Umxs4sW96dbo0eRNXbNd1+ScDM4FZQPm8nQ\/BJ+dabn0uZwqsz64cJRx1+O4c3qwTsa8ztSckaCL4b7qKYK3rtYfzPfyOV\/wx4fyNHtbRW609eYOXV7ni66Rla+hSOpHFBQzhLu0SbK\/7pdBMA42cCvifn0CL\/gUjkqhi\/1XWSnU\/CiXV1P2BaOTLAW2rutEWMovg0bo58u4\/2MMPXKpcgGEYc1ooXWycZVxTvTBPKcM8BLJItjX3xABbEEdbCqJefPMSpPrvT7kFbvoxuIQhrMEYbhaCQ7i9\/LCXmqFZF1qKrUxBUMdB3sSAGvPyGnLNc6zCl9lpfirhZ73XdRyxsTzFL0R8txBXqxI4IiPFWMRt0+xV2gAFqBECY9FeoG9nMFFgSlAhBIGGTVTtPIaltT7xYDVKzSAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQif1\/rAtDWA05NbEtqsQDOvnXV15H4jQAlNomWkD4I0cdKWDRiXzV2yYt67F\/2zz9IhbLZJ6yz1","type":"kadowereld"},{"name":"Karen Millen GiftCard","paymentMethodData":"Ab02b4c0!BQABAgApYI2hbHeDfES0QE9l7pnLSIA\/MIKgTloS1thlyAFgxG\/AV+rYnCQoHSn\/w3vWtjgM0rydLWjQdIqWsYKKeRBCXjqLWDPrYB7gaGT+\/RiO5w8mI9t3Ol0LnI+TwL3NqXRhFDarMkr1wBkqrynHfvcpbEbkLVdKSYWe88ZoroIiEAg3+q2tpn+fLwXuCvtUXqqqzYk+Bo\/SYJ0mbxISRzFIsE3ZAaUnLWtWaJf7rziyJa6jzcsVDgqpItpMfenIarVFcLQv7Sif1E4Q2o1WoPRmhvlNO7Z2DluzSaD+1Rycg9b3Xi\/pjkKO4YooCrDKDVthYXbe2j6RVsZCyZFJe9v5Egp3MUpnT\/XwiB+cbaSyPoC0YacoT\/cnhJ2aHTtV6HVKUZPD8Eh4jBdi8qAPgbBzr3E5LEtHuSYO8rWbZQMYS9EnJB0gm\/DtoPM4nHUA1pb0ffSBZmSQgCeNrr89ZfLvJZP7itZI+tjfaFoAY0LfzzCSge3M0LrZMADvqG8Bg+h2p6bnMx5a\/ssLUL7vnlyfGpl2OlhWDbJTkpqA5yt35usFniOMxkWnhkchq0BENL3wXl\/dAioDkSTdVPxgfZaOy9FSVJZNR2gCFmYhth6Yk55FBScUdIis2tykndN1ahSvH3tF1j\/H6cLFdq2B2DLoHoq3i3LeWBtvl61I98EK+RAJMIEwtPVsWjrNHuCdWhmBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMife0jMycTD84D5BBKAd0mGMSGHRKH+iwhg\/G8g21qaX1vqxzE1WJnq8OKTrrgrGEf\/fBxFsiqIQqp58gGC3vKtJfq","type":"karenmillengiftcard"},{"name":"Leisure Card","paymentMethodData":"Ab02b4c0!BQABAgBYdHBN0+5U1mCMTmWRzq5wTWWrDhl8i6q6yiiyPcG1froAbrlmhntvHiAeeGPwwnIdjfOrthR3HcO87Zs05HNaTwm9mhxk+3t\/MVat+r142qs4o5OKdIR4uYRIBRrjDG+UhUW1dAnNvrCCZ+kZFuh\/v7Tzfxy53ReTO4CAOFmsnUAqnynazVvyX9lMIYoTsd0KXjB5nLGI1DV4\/y9M2M4iyHmCIB59BvF5x6bnz2ILtfwRZtQe9HoV4WCO3I9titDktmdOHnCsQkKl11JZSQAIWEibGmWhuQmiuTHI+VuTW9qKay\/Ya5j5Sfkh\/eCOA90WmOaqynJWCdOCiYsd9IiURwsQ6SqH7kUoBJ7tl1UM8LpJyZcLDTX5HO\/nSwA5KBRw93cHeryBtmHavfH5VXP60FFMCQr95WCKNFfJv9FCVydbgaQ3UiMg6D1yBJtJqwOub6aWyvb133KgIpJnhO522X\/KxkHzVkARyeauOvRarsUlidn0h6IYAmwX6JVeJD3FlnDYBOGoY+Ik2DzvBq35ylfjKrNMEntkFoYOQZjaB+4BIUp86pJSq\/bxukfA7+ML7VYrXs0G16iWBn308k0Jle+qyUhqXC3qevJMp87eG3mrgaBr\/Li3IfaBt3o7ItNdG9d1l914lajAmVjxeLqW8Cv\/tIsCnal6zwBksIE7HhCuIM2CuiMCRzlhHA3BBpZrAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifW+wiTHgcFa3INU7aod3xbsafozYBWij96xh6jiG2bD2YdA984ypmZ41uA0Fir6Wl1R6nGGZlyVdrw==","type":"leisurecard"},{"name":"Loods5 Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgAPp\/\/FjuP+ULAnqOLFwnVQX3pGuTlYiMmSXXg6EejxddbhxBf3\/CPBEzIRktYwuVzYbMeNrxbAMRDArExdZJMcFWbBHOp9pLGcT4mRWm2pmf+aRdKNygeS3mI85xlT\/l58PpHhW4oXOzp0kh8UE3dPbbQzbMucaC9FJa898di9kK7CHBOinGqGscnbJuzBrD+O3Xf2MshZ9JtJhFFNbIyLgbwcv\/YExyMkAvXddLsVS76TlrPjqQsCOCEyCU9+wwjP5GRaIHqMbwx+5vD1Zy8Yh3GB+fqmE2JBbrO4vStDSUcRJmonZ6eGmS4DP76lQ46AVr1PY4KwZO\/ME4Ku0XH4vK49EJKQISqklllxa+2YkGAh5DsLvD0tAswfQ5LvvvmXIEacKjfYsKNKa7w+Z41Bn7PZTwLYp+FBnynlGO6AmRYgmJSEag4rCueZD0qJNrgcJqMp33l0eKNb72wDQLZ5EsXZ7YihTq9gL\/tsVo8sgOrZV1AKWhnIYzpIwSNeJJ3clkqOu24Tilj\/v1kqiDI5+yn3oaAZO3crm+GTMWY7jxKmH3lY130\/jdCMHbPTugonAlJalpI6s0vfA6LbFcYX2BgO867Cmox9SSBN9EBG7a7FNB07Pf2keQcdeaWg1DwldGPSMCtMC2oDaMd2s3exyrnEOg3rdbh6Q39rfhOJOxB0Rv25Orn7jDkaBqvqMf3RAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTmdrSny1kEEHmJD4iRcu\/0ZPmgSqVodRq5eFhZLL38XWtH7T03GQC1BdgABBaUgDAjZ+adh2El+70f6cA==","type":"loods5giftcard"},{"name":"Loods5 Tegoedbon","paymentMethodData":"Ab02b4c0!BQABAgCXTxvpM5NovdKZ1\/8MSJMXmIDzrG1S35D2xRgJhlfH+rHlcAPdEoeS5E7CcUDK\/pA+NsqVXSKV7YpPlzDI2Hot1wK8+vhHh9g3hCD\/cCtThplaywBeAKWQ1YYeXqCiSbLeNAtTDWs1RvPAwsWpDbSFQ1VnXS+kR9vE\/T1gG8pthSrpV72aUg\/Mm2mJGNe3BJxzou+2eU0PEiKW45EmQNs+1QbZLKwvE0ByvATBb6+JvaXJqdZYvk0j6i10EoavvcgMQEdTiyI2eFwX7o+F0B0GFRo46ACCQ\/BDwekg3+tPfDsc6WLwNn3BrXCR6bHAWUcPQ0EmlCRDdg2zbT0fyHAGV+2q8r6Fzto\/\/NEi3xRJqC4uYvKg4j0COUfZSJseBuvwKaSoEZmVyni25Y4l9QSOeGC90hJZ+FLbbo2M5VqftJII8VUBc0o5bRKXCAFBjn6iDHa\/FzS8PLkehLkAkWlU1QRUV6qDfOfzMhAT6B\/fGoXVq3EC+wdwsEhZP9\/j9DmFTuLBZ+z8L2yyZcDmhKD5137ifvtH7StDaSfpOdZWBGSOTpuA+E8j8AqfuVjyuoaNCEopRAV1Les4mIKv0juyIhxsI+cgUU4sDfKqvDkzD\/smGGhloC80enbncgLV2zCgm2ysuLTORBlVhhZBKnR8aEA\/faDii0UIJE9b5bOJnRC4VefeFNVrTkgBpYzhmpNyAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSuDGOUZ1xiT9pv3ZxvzDjXdbJ0JQnc5EWVrs9HK6TTPDiBmRDhwvzvrVYOzTJjaebHY\/rg6+nzHLXMgRRnq3A==","type":"loods5prepaidcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"masterpass","paymentMethodData":"Ab02b4c0!BQABAgBvbRPkCdday6ekCo+Z3GBDCWwcGOq5ZiTrLZoXTWGZBUHw5QuXfypU2GIcEEqLfSJ2B3jtCDUT46b\/LqyOskbXrcfe\/SlzkMpgtjYyI5p5o\/fXAV2EYSagdIVYN\/tjWvTLvabQqxTmHObqbeSh\/oIkoe7XDN5gcTZeqpOuPe348uJNEhns3+CuTgfuh5n03tkopdKlPKSeFvaN71WhOLmWnrf6cT9UTQz2KsI1oR+JVzSOcW5YACk31D5BIkaUwJaiB1wzinjIbJA5hpg8jofvqP3pY1V202mpWSki5vGWXhgq8DkqYzg4FV0E1i1jf8PMBH\/jkEOAkwSV2CCfhQLGppXGjSX+aGQfhnzxuP2JlmCRVMarGt7xHOyUUglKS25S1xkKYuhmnwSJkfd2UuGIqbkESIVDV+8SXiz400lAtg\/MdWMmvxszUZwPsRkP0eeCbvLUge47dYKVXb1ebWixC1BzXeZkGxOOej\/b+f45JQYmHVOvoLkzEDUv+HHbT5Olez4AWCYUk5OuXM7ao\/jmOa3DGmzVm6av9LahfeiiPO9fYcX8kwoFHZbKcKRVhsTwyZ5\/Zy25VoCLnmYcDt4hkRQe9+nDd5BePv53YyIgkkyDGeblw5NKRtTjisLo6PxbX68rGnoTEA8a4La7s2Q01QghihIiUQY6QzkLnn8fVxD7U9La\/f+dChIwRItGZbpSAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXzgfp9PSVL\/Gx8GNCR2wS2qzDA67ZCQ3hokL7QtZwiELsB5krnOCZ4XyCrVUK5QwO14XEq\/o4bM","type":"masterpass"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Amazon Pay (Mastercard)","paymentMethodData":"Ab02b4c0!BQABAgCkDBQ3tGm61ichxvJBt0uLArsrW0pZ6\/ZUCT4v3yeMx1GUHVywYKo5\/SBT9fA14QIYOyBSEvDzHG+EVDKbsq8ZGGO82ArjEbcpjYbvn8f3t10es+3Bn+TzlxvJiybucfxm2Ix2d5yi\/MTYYcdGKSFZlSxGFTF9VNDzMTkP80rzRYApBdtrFuRTAPW4h7z+tWx996HBYUbiv0g015MHCHS0SoYh2jPOHhCm17R2xBnf8s1jcpIDnjZAiMj3VoZemVSzcYMtumbuU+R5v1oUaH3deAEj14pu91iCgpOmyTQrYiJgg8p9u7uUCDXRYAYgoLVkBIut4PeFma7I9Z7gWXqrSt6ffHTdvO2kMmO0Ogc7IlrBrF62koBdnfuJ20jDEjodF\/LaKwQ\/yyh3qxo06USQVNvYXl+J+E\/iUbNgw5FR2A94I\/2MAfxiMDS0ztdBbAf1QzaS44oJJ3uIS6zlCGGcenxfRdXMjOXEKloO+F2C8XMvctctJVDgY399VCogiZTLNkz9STRrjg4r5cwZIw4KvXMce7A8KWSK55BldyGq0x4de0n\/lj4ko8o7ToXj+\/PryBvtUjcz67+i52fLxvr4i8iqls9wSBkRLVfKD+VfKjJxnVznDdsfr5aDBa4hGwANGbIuqI4gv74KXCdIWbbJqTfdD9VA9q49dg+Iy9D\/VhDFlUAxdRLmb63kqQ26dgAFAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQr8SVcjGZnuArjQaqBsW1KR6igs7NQaTIKzWHB8oBhPefQXAmoe7TzdgzdRb4+yoAYJPcPYlnLcT08=","type":"mc_amazonpay"},{"name":"MOLPoints","paymentMethodData":"Ab02b4c0!BQABAgBIfzDmB8qDGajvq2\/hGWIzlhAAftTCqpB3RZLeP\/TGvZeKFPe+CMIFnX1zNtOhy4NP4CEDmM8jHy8xXedS1QelN1pGXP1nTko5vMr7qi9EFkQcvSvZpwO5\/Cz0njVYjFgZAAvJwK4Ytdg4osnk+3X0qrn64ZbsA8ibRGyqEEBAClvIY4AMG2cGXyqru3ltxwVqIc934NpZ1NeZdgE8zFEuNRLdMtGmAfigLDkRpRf3sOlPtpY9u0ge93ibzP2jRjUGy5YLUd1CFJNx7fhtff62r8mNp1Lb9SBCu12cnUNVkMsNH3mbAtK+q2Ck7Jvd9QKiIRHbJYRnPv\/LN\/nYAs+Z0sHBC1c78hT7qDayuGZ+haasm5eem3V80JuMpw08V2IWdGunn7pkGKJ4ldXUw0tUCKD7DSUuLa8Nx68eiQxyzWWRq3PUYGUns60C1ZXkOKwOQOhCfx9jsxjNKqRN7q+9zxHyB\/aCM\/fZkIBsiNpBqk9aTCMQ3TkSCxI3TsFoefDOKZXDqFWxCPq6HVVGt259XwVMIFZzT6AKCdC7OcWeoPw02aACQsj9dnkKqh6HDGhAAre9pr\/mPC\/p7IcpB3BDnDQRtCssFkXUFhMNVxmxxyb+JH8FShy5YnaCU7P+f\/J6Qn2Z8CNJyr2RZ77s9N+nthMhKxMC2D\/3CjwVI66TixAYIAkZUUhlX6XEN8KJq4ayAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbFQr5zEUMohN+rPBl0SdluHCYZWtcZCKV7\/8yzvzDoQYYo28JyLUvJ85vPAXh6Ii46M62I5TA2G8Kje","type":"molpay_points"},{"name":"Moneybookers","paymentMethodData":"Ab02b4c0!BQABAgCTBiPTMkm+\/q0GuKneUn7WEoPf1DtL4xj6+SXQxAufri9s8gesf7z0fDcZSqiApb0UaHPJvZKWIEMonp\/d5F5h4jHOzCNqMK0kiTZ1l7vw0s\/aCawT0y0P7Ymh5Pgg2l\/wbiAdtV9neFh4nT2M3Xb2c+Do\/yzIOU0LEVauTvCyCrIZfHvcfi+hZtwwZPxYWAlzJKyVpmD5RYlf3D9OHuk4nNjfGXY2uyaf7w\/0EIJIhukqPnEey2sizgxbz7qWgbMPAwbWmLynwczbqfGiI3FZpS2zyajTOXk46DcGJSifc9H2arcxg+O11JhObCp2v2Stwh8DDX\/uoZOhdLf42sjZyioygBgfKpOnELyaxuevhaeNM9c\/jEnYDdSL9P96DifoCGLGpn5fAGADskxHszLyoFMOP\/kRbbIeSnHjDpwE4Y6rFLXOpKOFJdjx9A1p8SyHSjxhV\/G1ylk6Pnan44fRjORpEH+sF2XfDINRCwZ7EU3lH85n+P5g6c66vRbZMuGssb9KtY5yX3Jc\/IAQmY\/kS7WLmbemqvCCy1vMTwyk7J2Nhg+DFhLvzEgBwrDnCQxV9EzreJXOEtBnQ1T9w9nQmrp+NjiPVcHnfIPSRE0enAGy97fff+nxxqvH+yzm61XuTVG\/BRBjKwqbS4m3nORDr5klpPK3NhuUtTqpuCpHcxABoFJFarRJiVuHipKn6DdgAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaQpyBEyvmrF90NAwtfp5vweigE4s433Fuo+TBuMzX7RoiC5Iby4MKfDBrdEF1TRbztiy1ZO5Ec64oM=","type":"moneybookers"},{"name":"De Nationale Musicalcard","paymentMethodData":"Ab02b4c0!BQABAgBMClK9eoxk3I3\/2Uc2XS3cNA3UU9qdSYKQWnqw9cODwxat\/NB2rqgl8VffbUy3m0ptFDomc7bU8jMHoKRmvGuQ\/eWI90bRT98Djqtv+uSIdgywfdxmO7vLq1imx7eeGYJqGCgAbJSHjxmy1yZtE8tBK0dbtNByCbh1cj0NFHhTma9S+2OQZ\/MXDZizQ\/nNywOCKbdwPgsNnWiUr8wB+qFfjUokSN9xQB7eUUCR4b2XUcXhLF4\/r2SKgZuf+lgnuXN8LoQH29d4S4TrM0Ta9UKRPoXdrE\/Jvn8an6HZfdhg7U1bWMsrVUV4aGGyyAprpncPN95g5jTZXconVKiQYqzwcwJhcMrL4XyEmvkkxH5pM8CxRnHGXrBWbXomKODH1H7fGWMhFi0D\/LYIDPcM2Wfa3eZuJvZbH7i\/tuLPI9BzjdfMFzQE6sZbjUmW3l\/wu822w0TT+BgcPTf293vPV7WX4ijf8JcZ0ocMtP66I9yvvJImjy2Y8MdjCcXiCK4HN04CZe+VEKWgfKCAiv9pz7Xj4LfP8ohxZg6W8V17GgHaG+Hc6pV+2GppVjf9GuEqpVGRpxCE6wPHwUJHTdPK9BT4Z2ddmQvmjHBUjfObam+6X42XbC\/KGdSr\/qSkPOuwbp5Rcv6VOZi0+DQ4VJFzPfsMyePQPbU7EEcXQfVBLC4kChAj01Xd33Y+Ap+GLlHTmQBIAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTZcAEoJQj9aNMkMYRkEpNwSVuZa27xiaZPz\/680X5J2Oj\/Y0egTvIkZhrq+XW7Dw7JOmpkk1DAwVw==","type":"musicalcard"},{"name":"Nationale Bioscoopbon","paymentMethodData":"Ab02b4c0!BQABAgAGKrzkoMjtFTu4fnBoLjSBEaMe2XxSmcMZYBoyXHuBL79m+JTEbU\/n5LOmpjeHaVqUxziB5Tej3GR55t9aWR5HXY9vCb\/mxJ4qlm7xdVjb6Yu56ByP9+IjpIW2sTViIOsJpH+44HzxJAvWYHeot4XQaUf1YF7Q9tgHaRVPKqS0nXWJp7i4Nx1ExVb2Lof6WrkGSCdP5+M7tPKxO\/DBpXa1ldCYcb1ubWTyuhHePgvvTga6\/rLdKXyvezuKftLOC9JW+a35AM5O7M3k9+Qes\/cisZWWnvkrNyaPShCBrGwIWu9O2U6qd+2bbaDBEh9qe+GJdUkK5jxY7EOs7F3MeUbWoZiiNkKvp5BQqyh3VoLVGAiZJQqDaPlOQtX2iCI3cqYbwgQhUI\/Y+LH8QLPaE1Sq2gyAeZo1CCKa5Anmgj5rhpFt81SPSR3h+P6NeVNs9UypRDfn0oMRRfONoFNPsl92bLeqi0GjVqmI1Rqw8M7HsH1NLt1MjqkV1ea\/oR1Sv1mLTX7aRnaObFjTgDlAe2EW7\/nSigcxwVGS3ZtqNcksCWojYzDlpu58Q9tnTXRpDy69LjE6KgsC6R8tVumcqzdIWXm9JwWCYIrNZsjb8VXaNH1keUoh2nJjhudo9HpC35gPNqa3J5yRt91qq\/XM19UgunGFBMF1doFJn+NY4SCHExANCp7Bqi4lrg+7BndrxnriAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaOHVpDdzaZluQ0EsExLisZZe9P8jj6B28SWNM5DRuFVIYeo45SKNYL491pxNOffZYGHFCeHwS83mYSO+aNSMjgRow==","type":"nationalebioscoopbon"},{"name":"Nationale Tuinbon","paymentMethodData":"Ab02b4c0!BQABAgBSdBjHAWFeVqdlSeSqA0QDmRkRKU9VRbtV30FXKabZ2HfdlbzZLePz36F1dcX9zXR4BZoWazM3wD++T\/lXOJRiudsx+YBJzj1WSQkOey5wV71V4Kq5WPo1lHChvm1HoYlEJ\/8Jnw70w4n\/Wiq7B2IEy37XIoltDFQfzepQ0Vc8C8gOaH7DhM8koFeASy7CYJM2zRMKDfYhsr+5CWHdia3hfmCv67g8\/8JM2xXU8sRZ5tNFqPCTCW+DMSGYirVEqe94C5TJosaUPQdZ34m3HgQW0dDde83vWPeHBD9qq60NFK5+ljsYboh+I\/Ko7\/qYkJkLjJW6XRjxFSsUytrWHtvUE+g47KLyQpg+wI0Kl7yuaCdlzXqrIDOqRUlzm3\/GvsOlQFnZ45FbvdSdF2tlWq2hsheDNgx1UbcsGlgR2xwDqgfUi1DYXwjHvLgg2oyfyCTjvWXZRpSX0TMYfroD4eBXoUSBHNsw4dcJ24LMlR\/4uDc7XNDATMHWcDd7TGm1eND3hl9QjeQpqcdVpsY2ag7EHrufk4AdEqcgCQwz5jPXsWXwgZX6SIZfyGtE7bKNxDl97kJ9FQhSv2QnhAiPLAleg3Qrd061MC+CAjqOHxCGWCs2v0\/SR3qlRMkk4WFn1FHfz045fSfRRz14x3cDcMkz2arEv1aK\/OHmpNs5Ki8+6RCuHNwaTlfgUy+vZGMZA\/xnAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWnZH3JT\/GnQpJQAGmVDZNXUbNQ03jywRl\/Y8cUDt2sV1z46Y2z+hLkgfwjd1mEQy4RAXTPdEgtHP5txHGxx","type":"nationaletuinbon"},{"name":"Nationale Verwen Cadeaubon","paymentMethodData":"Ab02b4c0!BQABAgAOvsGqCDu3E7De6XOZvDu3GAadKeXW9pAYVtP+w1bqxGPUsNpOvkR9VtnoswfuV9vmp1BPUhOjLx\/ntsAIA9RXqrzROCo8n9p7Pv\/zhcF1sVSecN4O1ae2HUoFsHUxn1MHWdOwJygEWEvNZNroVe6z7S6e8oK+CAaJZLO8L77\/wMMYtnXG0l2hIehWEqcw+dNR0hQO6QrLz2cnekzu13A6DR3pkwRrZ1oyyfGqTxqb8JpSS6xuiXgryPtFOwKccmnWH4nHNu8qc+emuRipL++dlIp0bS22YhVyseUuwBBR+heYgXL6hnmNjKqCD2Qos2XJ40oO3eNT96hxy+kTPHkERa+LlPnBxb1FFh4iEir66COeE9\/YGmnCaJ+GyKGw9BWIF0lg+qsNxYjDDHQ5JXnddzVc1f4mtjaO6cyR1zSNQshu+IXraPkczhvGI4K2BUJpEOp+9zCCWv00U7f7Hj6k\/7UBWM5GQUVkBiMXXJUmxzqxTyXhDL0AikNJy4zg+QvgIjQHtL8TFdGd\/vH2lyKtkDrQNnHfLgyGM1kftBlGwn71BpkBgHM\/S0q0laFnHGlwMmOydhWmy2dBg34VREea+8wcz6jTKeCepRp4QZRAyibXdoxah8OpL5AfNqxzXfTR1Q5wQCTceimL9Gj\/mNQLOaQLxnkDkDD8zsgWn5GI7BDiepPIoM7gdgCyVya5dTzMAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTzqh8Ewli4hyfJllzYIZ2tLPPGyRVA6wXaTcI8+3t4S3VpFjS1i+gGatuMTftnuF0xFr99rBCNaoVT\/AWKSjMETKiqDdp0=","type":"nationaleverwencadeaubon"},{"name":"Onebip","paymentMethodData":"Ab02b4c0!BQABAgBKxnRmdq4ct6jF4AMU8YvlVD6PTAZ8LGgOaj7Kvp7Ty1jZpBKgQE+nWkFVMxLWSDVZV9YbxhXa1Ux676iU3KdAvarZ3SNUMx14Cf9uWsfNbD3eStRVuri1Rn\/a\/rtXQiGgBkl9MPII6kQbiRLoHf2VCyYMsaazdZSUVcq22oLOHUcoL1Pi0gZ4+nGWzUWKgYh3KjqtavrpUEo91vBbz6MA\/zJ8o8DnKjhcbK4SgHYj4EdrN+3mJ+Swdm8FN3t9WvQCFcu6ljhyYO9qeesaJo5xhgpeMtrGweGiJuoNAxE3k2l2Yi\/062I6AorN8tfP3Ndx8PPhqmKr81hmRhV36nWksuCz6Xiw4OkQ26Ra6xQ3O\/x2Xg+AZbOo4Ifug80UErQZrApNCe39tELNy539kWDMrvvbWDoT86DwRgvyGiWAbGrDBMIUUamTc\/LOV3HLK9v6NhyQQ+HR4w7W5\/Yaov8EjK4Uf5YygHdJfw949TbWEnYISutr59FmNp1LQ1U3FfucRJgciOj73lsvumNl9sbWS9y9vxPGBfQyputojHifrxyOJCLUCO47vMc8EWbr7sY2Jp4D552w1mfhpyJ8ZNC+rV5G0YlKqFMLvapomqmHoKdxAY6Zq+PThEZfmqc+CCeCbeQuOwoDs54u6DbSK9qYpSSQ7S1JxNVxZUlqb\/+2zxB0Ss91WpOwJsz+iefTsbBLAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYQKtCYgKMO+AOBDbpjGbqKyXMBtXI8euZBIzH1RBRZOjQq4QxmGtQMvhdwTHZSerMybSkw=","type":"onebip"},{"name":"Plastix","paymentMethodData":"Ab02b4c0!BQABAgAz0XP3DwHY67V8x1Kq5j4lUIyNcxhyYTeFvi+o\/GsDs+\/CUmZOgs36zBOxZoNQlx2oZE4gX1CIvJW42O7l46QO18yk76FjW9z2hEiu8OUBuyVx2LCOuoGbf6nCpLHDbptCJeWmUVjvvLrEp5ecXJZEF61LJRnsCVBPMYQGC2HZg+G5fMwgmfTQ5GflgSWvJJNhYewaZEt67kIEMkH23fEWk5fcrwXsK5RLCdGiPFtfroryjT13DLimjis8cn51wAeypTdcBLUDb3YDVRB0GhTMcTBOUawfga5YA+j7iXUBOTZA\/s63dDncGLRAFvMADdXHIwAdfzpcfXp73P5WmUy1xVfdFL+yT8thdDbsimGMFYW3B+DgxIST6DHvdYRQcWeTWHaeaBbxBLSlssgXZ\/uwZ1l6F\/U62jq+lvp0SLCL5VV9kNjYL1gj6ILq7Q4kpBlakMUCzD5HyXFzJTBIO4ppAnNwQNXxV9CGWWejaJ7CXKtvkMhMVxQuYEdudJuV6rjkgfZ2TaHtJ8ZDabSQCSlHwgNTbC+NmESnQM8NiFWUmRUuDp4bj1xyKsSgTckTKlGeYVExV\/DNjLhVETP4z2nshwNjKljFFU6tswU8fLlNIS5bSrBbntbDQpz9EyXSxlTGMn77KUBHsfj1snOMIn+IyXStUMhy+EukYyAs0Xm1oxBzPVY6E\/USD37p1Djfz7E+AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifcImGyztGTi+gJ8yHHByRjLvwsi78BpqhidrN6Of1kKrk\/399Y1IfZp1L8TkLTL8CPE\/j6ZA","type":"plastix"},{"name":"Pluim","paymentMethodData":"Ab02b4c0!BQABAgCpN9PgB+5PbyuCmztxgw6+aK6ao3WDV\/dDAYA4yaeYk0kSzCzSd0BScnh5Qou7ii8HijCNxdlLKa+KOfRTK2kUey4K0lHKqzjVBWg93+ls1WdISaSlwN6pU127jcQy7ayLhtt3Gay5zASPvNLuQfbQQUi0BxlbpgOyYN04gOyhdbHsbGvRqYayMNOeXLg6kcPJr6UtNvKvkX77\/FAu\/q4UujghWe7pY175G4+kmdYlo6iW1pqdNjdFJvHizzS+MxXozRckbl2rrxrw4PTS5Spj5i9EbfUoaBfoNt8SrDyxBroh4cUqPkNbX2gN8SZMHZ9Xp5EWPK\/TlHNfTiUfgJKAqXiN+9NTmDowtNOufhtckm679r1BZlhPQ9w9Wqw4NmO5lMv2VfQfO3q2QKM4DTMzOms9EsGVTaXixB3lf6ay+GzQZiNQpiB+PtCkcJjkRtAkuIR83Ru4MSTI9t11vPSY4sQiNw2hOkxUPzXtDinSAJQ95ddPfxS58DTNRIpIgQ08puopzECpWkB\/JXk9E4ZPachueVcLvAm4eOhBUYggtbQ1OtS4ifoilTHUISmgMBia+GeI7kPWfPjBumAvYA6RiGTP9I9F2XbNQNhNPj+A9Xz4Tv0ezu6Xatl\/5ikGUjArUkFUXse9WMrAQ8goojA2zl70rIsfD8FApqUGBuviPRCGzN1z8R7ZetTAgE8mqbdsAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdHayxrlLM4RXYxNWex0cVNe\/l+mirjDxyZHFbANdCJUe5MtnIPznUnI5Kd\/ODC4AMbU62fupTbSvwU4","type":"pluimgiftcard"},{"name":"Illicado Gift Card","paymentMethodData":"Ab02b4c0!BQABAgBP8UNwgXCInrEhB+jYdTLk5ia9HzyhVcM903mjO9aU+YI6HwyqK19e6kzOx14TPy4uVwC9o2ZSG9jj+Q4P9crDepL6ltz7mEdBo6I1d4j\/dPbg\/ilL\/I\/WONbzyQuYmBBzZI1f1GQG5U+iF+d0XM6h7RrVS5xU6DZLkFkn8cY\/QPMu\/U+CDdjJKHfTUCyAnNlkBhM4olMHJK9QKYsxDLBbVRC3PeobNU6mP39wCCOqEGph9xqayFnIZnEI2gw0axCg\/m1wCAjKgwfzlLXt2cZE2qy\/V9xHxE+OZ\/7rEyAg7YPUYN69R+fbXfRNq7hvxNeZ0D44oYeEhCOk2k8Ue8AgnyUT9sx2gehBVw3GbvRIQPdhSN0DQGVXiR1MDgwt54NqvyiXEqR+gtgyR6\/FcWV\/\/e1g9g1ZcvAzLaFT\/CB1oepfOyhIXe6A2WpsCgXZ+ivz4sUKNRcZ4gcX7cG2beBWsGz+w9FHaXHmY0PxygmvA83PkAK8bts3ZM+1Z0B9eirW1OoX8xUkO+UzesCuHW4pcu+sr2wZD5YDSt5twGzzcbcpmSc4Y47TmewJOYl\/VuIwDd4l3DwsscQScoYQY\/1eBjC6IBOlhrmsUbL\/yq9917Ij9ScYEQ0g2pLiyM8MZY1lLHg143+ypIsfkTzIQtcYr1Bk7imHgnWIR8vqf51EkxDWYMmtYA2KtCSBqaI3nAWYAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWGCfN8Hg6fIIN1PcOKhn5oAXs30jSfkeuIABFhakzz4Ik6vl627\/JIlF1x5yta1+FUrbmuIkryal7ZE\/paOQw==","type":"prosodie_illicado"},{"name":"Rob Peetoom Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBPrkGi1lxsmHWAZ5YsdvcYyX5gSxxx1GKvThlarnANnNV3\/5dcTI3kfq7ED+DIuscvS33bMGGdZB0zWWk7nEOKodpo\/QmhQpuqsdy126he55Q3ld+CX9aigM6eFTmCqy1bQNYqPJDzp9CHl0gKxRmRjHeJVAgVN8ixQ0NcfmcJlyk4cX1unuuI8jfLbpROYUij0bLQbQXIC68sgBM2WDaJB8vymgN+XAJMBsRLxNe\/7FKOaXptqv6L3HxleCXdV7hYbEvQsW5BVH4jo2u2ECmC7eqeU0YdQ8qrdXCXj+TAtI7jyOhSrEN2Dy1K6dspL2ralleyHpm3jmrhS+NRDr\/ErlvEKyLB1+xkrgDyMdDj6uGHNb0g9UJ2O1MU1\/+bc7GfeGp1CRDq24wEbRp+YtNbZ5e3sD0h7o4E0iQcCDpowZ1EsMqUsy1ORCtznaz30tL\/jK30yfhhuTtNhXC\/xvdlm\/jkDiZHYRUT+1d\/GHc1Q3HxJnpbqkYTJBrK32gu7\/lG9b8Pob9n5CnbN3My9vMLcBQ5cK86d\/F+0i9hSmj+TiHS3cN\/11FY9TRH9neNHLnaLmdqjSfOp\/unodw\/Ug9L61QgOB0V2d1H3BUM0IMWs8OBLFqZ0NiDvVene5COcSSEPIFfO4+Wq9Is7OworoKwzaizc0QelJPzbw5gIIccXRBuPDqtnhc+xY7wD8T79IMeAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYBTWBV0iDuGH9uoF4QDbEGJ6Kdg1kmTtSAVix48HVSEXHf6AR8qT19UQOL3PSAaXzNdWzP939pCbZ9b2LzVD2k=","type":"robpeetoomgiftcard"},{"name":"Shoes&Accessories Cadeau","paymentMethodData":"Ab02b4c0!BQABAgCamYFI8NGAGQRFMz4zD9ZaMmORJl7JgqyH8MSEdmNSgVNNXCdjwxq42EpPta8vNYIJxoHwocOIZCR8zkOP07CMS5\/tJ8\/GPz4LSMwBzc8cPxf1iGec+7SwpetVWQ+PrBhcgGN\/zhh2G\/XZT2VufjZyy6xb3H5BZRtzsCNLjAJvd9LeWjh\/cVymCuKnZZ8po0BxEiF7D6HVvHqOt\/ien96m8iAhAwWj6\/bk4GdmhWaqA8DFqb+qTbDQ5CxjVtCVB5nFvbquIuFWsuA+vV0FcpmJUUXqRi0T74qLCpoiavztSedKK3tCs4OxlOocgX59DIiTdnmTSW6RxdF8QUavk3xyX5XRhO1qGlNRLXVXkEjKhwrMXHUXJMQt1yMQJ1vd8gLCgwNtJbZOkEr83C6H8y6LazXnhFGDVWKKZ7KCS+QTOQ2mtQj\/bRa6DKTenJXitXYoKFKMAvY\/MuNPJZBj4np8KnzMDgpnJN5sLOyrWQFczdYEVPPD8oYzBagVRxVBdwB5+7I0h6hxsKfAGZIdbW934p2Lp72b8SmXMPZval41FS\/j8wJ1x6MbcQjBbAcz75cHIqBpOXRF6j4dWVndwaKcaxzBgwz7162rI6OsMRVrGHNak\/4FSM68ffeyUHdf3NA\/zTE\/\/weNErLmxjzvbNFu7Ghvu+IhOtDTyi3ct3ewGRCP9b+BccSXwIsgJ+NkAvDIAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVuHpmeLlJGlRnY9U\/6b3rWTtSTca85zykpddNhov3AIQzlrdIgACu9SOITAeyv740R3f0t2L3fy","type":"sagiftcard"},{"name":"Score Giftcard","paymentMethodData":"Ab02b4c0!BQABAgCsAD6QS5AWxVyPO2sJyskpyFh\/tVIVCByXM1cSTo5bfw8SypTWe+4ZlPHPc0ezt84DhXEr6TOfsjXS9ASKFkanm+AQvEvWvLLfO+l+T3RpxbmOQTGhzx\/y0Z2GiPtvylE+Hi99Zg5kAqwW1U0B+MrnN3VQkT5UGScY2\/oQPtpDGIxM3q1pOJ1wmc7xU3TRaw+C7r+WQhGmXvAyRqYd4KWlRkNNzaG\/CRXiekrp3dMp2h\/FqMetJnUyodp\/p3gfC+JtpC8UDrijl7enUJ3pN4VLYeeAlU0XtXRFjqT2vT5Pwb21ZIPvY0ViLVS75lW5b5t4zvGH\/gU0t\/0MuLwBEi9NzfH+zKdIBxldODf2Daz3fAMfo56ThHC8UuBncFYHXYT04bMaVSbkwfFgxxUXTv\/LwYZYKgnOkU4IgK0ZCCPjMpH8xLj24fUEPVcPJI2h6C1fFWtgh0H2lP+XQ4b4qOMa7b2paLyLNEFxI\/V48KKXBFOtpkino6vXzKEpYWjTalwA+8K9PYfF5FFOXym36jNY9dhijiBoA9\/qoyuQqZmrmQ94HYkRnSIR5wBfkx73Hr0U6stj3fwsd55M20JiGKp7bY2z81VCc2z6mpmjRyhHJXG5d70wX3ieNqKFNStHyW5+lkIeaJW404Svytck3kgchxou6CKVzvaSm6aCsGTG\/RCFmAjn2Z6NdmHBaQrSXcutAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTD4OtVWJcstgpTY1+ZIpSrWXEOWsSqSiZuQwnq6u95IdDrYQkulLduW+sOzopMVSSmaRLGtgdS3Y2AR","type":"scoregiftcard"},{"name":"Premium SMS","paymentMethodData":"Ab02b4c0!BQABAgAEOrM9BagQAJYKZQNCiGHVFFsCC3VuzYZrfoCCn55XO9TnTaROMV0h\/bGll57gS7TqiGuoCeK1l4Y4V+aNv5OC5c\/wAUBYDw114hWAsetFwu6pXLv1br9RIJRczpyvJlmRomRLPQpaN7cls0typ5WoFFzp9WpwKweFBC34ZIPLEyrVyZDWnxVrq+kP6p9BfLwGaxjE0cxoTq7VLPYtOpSU7Pxf0fDmEd2Jmb0ZBq6Ed90TYs\/EyNQX\/UWEMjkZstMGB86zCbroxBMLZBmF5GErKIIeyAuAylvyA4LrfTg7T00AUEyD3X9viyHFigtxUkhDGWpvK8iS1cVmygqUK3h3DXHvzKmvFOdfmeI84TEhflFgr6HGCNSXKmXmYVVZV9ZJp0nDrNWGvIUqfBCfOc4N9d7gMFqJsUaIW8eFqpwpObivqnqtN5ZMzpWp5Jc3Xdrbwa4N6e+aer17AqrUQrRqHSr52XtZiIWtVs0S5XJNQJRjNU\/Wvc7rg4Y+smVcfpBJJmhWxn4EPtNunALAoMiNRPDxJSOoJnM2aampaAQlmc8A+EGHsykWCG4xUjytLYWcvOn33lyEIAEui6Vphq4sdCnAfSebf2g33BuMZrjzJsaapVhjtARxH+mT33kdgm40D0WkE3RplfCCAXL7LOQgErWdRYoJfTxqkRHlI4bwgBCEwecph+cqKikCuEyH6i+vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYo3nNjRHRR0bt+z9AiaiGKI3Jq8ondSBT0URcHGdoA4Axf1iwA8xF6ux+c0RBBUoIM=","type":"sms"},{"name":"SVS","paymentMethodData":"Ab02b4c0!BQABAgAeBmmIFVM3F7FmI7FUeX8E01jMco1k+S3CS+awh7A3cCfpKvVuolk9y8ot0HN9Z+RnZnVzRj2khOGPL4ArHUHJmBjCxknuuP7eVEZqbAR45z+FOl2uCHw7508\/fLLCLg6F+WxliWe\/9zf6\/kLz2rWgo2YIjEM2Id7uper4lCvXZW4pe6IRMABXnR0owxpv3ZFyGY7pxGst4uLiQ9NFmbU7\/5Q8T5s6tSvoTTMhQ6jYsQQ1UQGUxS1DzPaI+QkMiBOxB6iRPH5hvnLdfjnsEBFZqFwDxqmJXokHu5pA8ZcPD3gOasK0yxkrOnJsvIYxqbgNYf2v\/366osBNzspcwHySDS+6qJY3ELOhr3iXu87zs\/JF993pdxvcS5isDXPZCUjx2zt6gqvvOSmmUei23TXbz66N+ESdfP2Z3AeYbA5U9T9f2T3QpIQeas69oQk2TPrkqeC3uU7Hpebbg8tkE34cWCRxWnwrtCfhZqt9DWMDc\/yZEPz\/P9AvpfcDb+hRe+dlfjPiVMSN1XB1Spc47amAKQ40f7FJqqEPfTe7EpgAoykt3cOPnH2DBQdkD7+N9nJWX8586qRXy5iqF4eBgpce9PhNYrkAOgAnKINAZt5sHmXqyvbvvAtw0f\/IViyz7dGjBmCqgVzA4wqpEyKi6SPmo84cJz1aP9TmVkRl4z3HKhCf\/wxj8atKh+FTzLWQrdDGAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUdo6211\/Wzc0dqvxJR3\/jWN028MVDDJ25rQjkrVgftRgtIjiWwm7vIdtV0o+QnEa+g=","type":"svs"},{"name":"TCS Test GiftCard","paymentMethodData":"Ab02b4c0!BQABAgBolc\/4\/EGNHf1pMDEsUskyzhi9KYN3VJ0l3+0ZjemuURepWRERtEhwImXhdl5R0+cnJbs5jefQfLVytf5e563aoA4lwnadk4XJS\/H0qrhBjQ+9uC8ZFwxAKM8Q0Sv8t34aidyRAFl1IxEc3GjbSE\/ujiYL6LwwCoRNOZB2GgojHGZPm7Trh5Q3WSSm7d6LspS\/qgLN+P5QdrMHg3395mh4ITHNll4LeBePw7tFjuaOPB7\/MuDxmauyaHDs23knh8xwRKFvydDikDNjANai4LWhNX\/74YWBPiQmI0GZ2glGiWUeRfyaD2VhHxAiYdPLQT2GhcDZ35o7Th2wX4HSg76TT60fL3VXOEOAinunSOTQo0dcY5aN55O2CQ7CzK2XxBRc36Jy7J0gUKk7fX+Qa74eG9YGfHGYYzN2QIDCpFK787syWcKQ0Y6AMyQTYbcIs\/iGkzZ9V2URyBh8sUCda2nhpBgLq05UBRjPu73Op3DsS6nU6VxPg\/BjGc\/rbt3JF+cHbFQDfiJKiFQTOTQ25gzMZ9fwW9pi0ED13Yv4WCGVTbbHGoGePSbMyopjzcwcqhSb1LyPmpKPoGeHS3wnrBRK3nEZMWUJ6fNkX2SCCVB3\/QeFxK9Psmr10\/pYrso2Z2lD\/SdoMebrdLFWRKHBuI98Z0vHs1yyC6TJhJ\/AQOfjxxD+4nyK94vO43QSq2eOfs0nAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWfqRm4x6b1yAPMGiiE\/SNY05neMsJjWAP73Niv3rOlQnzl+TRhMwVGR2URszHeFIwAYF95evu7q+h7Ui5M=","type":"tcstestgiftcard"},{"name":"The Sting Giftcard","paymentMethodData":"Ab02b4c0!BQABAgARZxSi9l0bosY++4DiKLjUe1\/\/9X4LNxVhzU8cuZlqFg6AKs64qmU3Jz3ckBYIwawAQ1UoRP1EH6l87scIb4E7IuQC+Yy+D86VuV4JgXp\/8blzq6Ix7uruU7TsGbCMiRv+aI1DWSrmjk\/PD6yElbE2D6wuN1zCz5u9K9FAH6gh8TztyGqnpj07fuxbJZWGd5V8pi703k3YfdSDAaycUavf\/6aKYp2oMGKxDngbxJ2l0qwoQfOrwwAVFAoXIIWkGmUmk8Ez+bAThUzmOzJ5X93le6sJUPQpxN1c4Ak5avVko9DK8VWtamkIGXBoW0cL\/FQDxM\/yfvIbcsL64oCAFB+5LUv7+5E5W79YY7Wf1f7U1ok1bk9QWgFvG3pr8PqxoITc7LpcIlitBeclfsBD8C5Z4KajJN5k64ECtcoXUdaGtE\/RmbgfWDWGjIcKsCnpRcS3fHWeTFGFatbins7XL\/v3LVzKVPkZpF6TNGhsXtqqgZeV+vkIkCq7E\/GDddpljLkspqqSVvayYEf2HvKJ7yorY+5s0DMXaEqE8ZIdI5MF3SQXDozK2oqpYSlOY5bPAA1t9bR9PbvN0NX0gtjo\/bcFKs\/steFeNY\/CkXMkSq8VBnV3L4xmOBo3fNN6UIOFIehmrZpjzTl1xuLzL6TbW10a2cvfHCxn09RiFMeDeQrH7RCCTI1cd3NmyITBNEieuinBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTU06\/CT1jKoO7oqHjl3sfhGodXKB1a4l1iTtGs9B3evGnR3Y0sjvjFzH8+ucdSZuWJxSE+1lOP658DGh0hb","type":"thestinggiftcard"},{"name":"Ukash","paymentMethodData":"Ab02b4c0!BQABAgA5EDRTW1MJj4ec5EAPY1ATwMYvsgnwLTbirwaXJCCGiCe8I8CgF3jXymhiHUku2JYCViZcRK\/tCz7oAMUX4wxjbZghHlmZqdzP5BE\/KDwvO2Vsxr\/qmSotuFvbbNigiEmkeBj6LoR7pQGvSVTjcsp1W3mL47snog+rsn+jkj0pXJhZ1U8\/aXrbB9wYuyaPWYrtqeDa1PL3BcHtf+Z0wNpdaBP+LpSpgq+klmUARH26RgaJ81EwnCOxESR4Uyj16bPzmAJUTxMaZkC2jHughbG5tAJn8AHFZyVTMEYWOM\/1aYZBJ5v7KkJIN\/Onr+oYhQIaEvJH3OplSAz\/DW7z8+8jJ0+5Frv1\/RCApVUSfIUOlN3q10OtGkkDgGnQ3ku7zMQj6AMrI3KU1tsmaw0C\/B17ZZ4z1XBSgwvUcRiz5M9aNCg6yNs5EUvdYd6hrAwM1LDvrioq+F0gWlTW3f+8Pzydx8GMLC\/xcYG\/CJ8KWb\/Qwi2JXhrG+ZR\/jE+VHvzSt6zuWaWnFP5pY5lr5L0tki1fbq3tT8EwLP\/TdF4LX7Buk6uv8jkQMC6pavHTJ2zSfmB1OZC6VJs0KbSaphSVhe9ka5SPrrzH\/beuNQpgIosE\/tKIVs0YDOepJvyPHV0fXO51fOX6dwl0XSSnmVnpv6Ejf7NNPkaqrHZ4TFMamIGhzBBC5PaMxFRWVoLbpQ+\/zanlAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifd+vkInPycf\/fO8hcPcxypCKMgn8r6bUoLJ6gYhTB80iJ2SvRW7UelG619SZCjeiejweFw==","type":"ukash"},{"name":"UnionPay","paymentMethodData":"Ab02b4c0!BQABAgCyuA6AzYVuq7r0baj9TvTCObZzY34GhJXajSgYTq5YtvuqCLGYU89mEwIDl8WJeGPmeeoKLKwGr9D6K8sinPMf\/prc44smlae8cDbjQFVyHkA80aOICCEVOaoj9Ku3pGf+1T3\/MuML9yxaI4LFziZS1oTw+K4ca0Lhf3anHgK0czR3jjwpyywkku8am8L2nTZTBms8lwo+2yZTBmL\/vV+WEZhk29daHZWMKsMu8luX5tgW\/E+UHDye\/t2riHv4cBDBns+bV4\/46JmR21mGYqyH8UwtbIFiSJBmR0jo3\/jiXNrwZL\/gE0KKoDYFQ1BecK+2AT+0LkyFdzepqMEL9eMLh\/Th+LbGVlXFttBy6vNZUHXxHbHWdW3u3RgBCpxwCdHy+fcSGfaOKTfUBuSB3Nwd0pHsS\/659ocRfoRxO9pKOGVIqye4twmX2AwygEI8iw2maF8r1JmsvVvTliiSt4LJLLvs51R5atfLqG4yFpjN1Rb3WXtekzncKfn6kADN9nnUHkI+thX3Yrj028TyOXpcGSjhVLAF\/YUFjHnTQuc\/0mY+JpyqtOBamq18DGfFIjwoXAq0\/rRiJVsPwTccI5jS9MAqZwVOl70Q27fYYG3ujiwbwW+REZlxGVOgCDu5xznDKLICF0YBeAi5+3dxfLepkU0n2WIJgXM2cX5pgVyqLhBUouM8o96DqR+dzPm2tuAMAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXLVyNJDBr+PMaR5skK\/WCNJ7GraYtn3IG53OlJhFTvHAkSpSXjr7aNW0fQPF4V9sKyqY9eyHQ==","type":"unionpay"},{"name":"Valuelink","paymentMethodData":"Ab02b4c0!BQABAgCXS3+Lg6LwZu9l\/UIyfkrHZrwgOEU7G1xft73fqNOT+WzZ1qc6RGFxgbgfxp\/YT1c70OUKbO6skjYBHAygugKQRw\/VR\/C0KeRsmP2peysWmHeqTr2goqlz9KBd4vYS9SWMO7gZyPs81M2WvNqEECIsA2EidAoKNtB\/gY8RTXzoXMP\/ZdhDMx3jOwTmJwngiycyJA46d8oo6eAFeiO9iJg5d\/VfC9yN65uc8s0hBmFmOqdMg7u6m+Qg52pob1K1U0uDgnxkWdcYwndFwjwz5WmFZGXYOA1U1VCt9n1Wut9L\/U4Ninrw\/E6VxHKfAgHHYLyLhsFgLQ1DLRv39o8EzHF6EhwT9VofcqxOXxff9DxCvQvWwZHch6SSKqDLLCB3p66r4RxAJ+UxBhfmi9rm9Tcs2AcFjEZSWdTYLtABhlTxkZBg6GlzltimC1RUNInnmK1Ne4LQIdg7uJno2PLvPzIXFgE1MVM+E5Poms8mXJpwZEmsouIFfZc62Vn09YmOwPJWiDkeyuQ9tdyiOI17hlPgcsDZTRXQ8Fj25RB\/L4NoBMakD9XR3fqVsoxRW6eWmhjHEEQTvwtEoPtQo\/BR8105pk8fb3L8SPjxH2jcPCGlF9svIVWJgt+DUtit0SKfRKvb8icQoNzNrFGTlsfIAhLSTvcvu3DDI8vrLJwOXwE+TBBRrXSqOwIRPwEx7ifaQEd8AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZvexSg4zbtYaHe40B2pdrLV2LDz5V\/XHItrgI+22VOX39R8C9vv4skekFaHgZVxkstbOzkZCf8=","type":"valuelink"},{"name":"V&D Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgBXdMKsMJE6QVzKoo9KqxS\/uQcqEhtL4e2+W6p8fP9l5tNvDC34ynhQfI8e+XPB3WawOdSnwNB1HTeRxN3JkWLm\/ei0nZjJObQFqjD9YeS1c0cuPSRMnGd3kogfOsjt32SFt++BC+NM2xhglKqLewi35NSIeFpEDS5TW1VuIkLSUsDay7rd7Nxgy2Ob2qGyI5LpJgBIKhteDfLTW9Y0v1row9fG9xGfOaGWdSXLpDii9ymngo6ap\/CDvh+nIRmr8QXtkb0jKv18NVAOpF+Icd8jbNCC+0RIXBDMSFiPE3HQ6Rg5744p\/3dFkYU90t7FnG81y3IVvlPc2WDHqCC37hNKBxcx01PuB+q0g7384XDdt0InGgeoyTsRnCiVj0dgBDCCwc58tmLrGJOCjXXUEfW2fRn\/P6ImmbfqSFEjVo5jYf6fZOoq8eRqbIIDrAPKEyS4fAmvFdX5XLwsQ+9VZC1DCseVTsf43Hcjtg9dZbFfEaCQ9bi+jlgah5Qt7Od6X0ZLrolPnlxnEKgLqVo+Bi2n4ByeUgSPEzWeKyjM92C\/4Xz6mFvY1reRr5FOyCu7Jso2ev0p9IcIPlx4PR0SUndKhNRayth+2mMmUnQnFQ6uLdh5WFPOwXJtvAviJEg+Ar3yjQlqDoMypKP7yik9oCNE6s4U4f2VbEUTG8CilMPh4BB2M\/bd05FUVn\/nuRXJPCIaAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifS\/x+tlxsUkQlFOB24V+5fVdy5RAOSJ4MqfntnMMd5C9PS9yyLvFpMpl61Ll5XZ6h+6HMZYTR26H0S8=","type":"vdcadeaucard"},{"details":[{"key":"additionalData.visacheckout.callId","type":"text"}],"name":"Visa Checkout","paymentMethodData":"Ab02b4c0!BQABAgCRBzsU5zUnZKcgmFhYDAXqzYkmTbNDzWpSQ8WDlMrVK5qNsuWuy2ZaXnD\/Wwu8w86\/0Hm1E+ftEtsx1S3puWyDYsn0HkGsn7LMf22QlYTapAzVKfMfy04+ftonzfa8\/F8CwoPrwWZpLDU3fHuX3BeQiZJnNPJLBx2P6Q+R\/jLnOLqNZLJQpn5AgINh2PMVAWFs40Rj4bVAK\/ZKTLovtrvOTv9q3DrbfA4Yi8FCe23kojjTS+L0UeuQ9UqaFsDon69UPlLBgQCae\/5mLBjq5+VnRp8g0Rh8F+8ubNtYuV5CRg7eVv2EmvKru\/HbC3MXr6QLk3ZE+9Z9n7ZxoS3Ka\/KyYEF2ezr\/3vtO0Ow1z5eTGChZbH7nnIHrrp0oYSrm+sAzuNbzcom578Y5yfHs+x95OFOiWg2EcrYgvhiy6JWzKDkdkiPbU8VUhiW\/WDO4g5UZU7Xz5l1dAaUQ0u181Z2erZYG8uohFHaLaCoWAJ7q7ALJGhaER3YoMhyIvxF5PDBHo+PJL9fQi7DBJ\/4u0VN3a7JG7Cl51VDn+2+u6mp4yYIDyel8AG\/dQTEQzI8goqpVhmhbztIYbtuy1Gp1bzpohKinkaz85KkeSjDa4zrgWeE4NcVFXolUBKCMr8lbop2bC9e\/ad5vIgBbQmcoSuvSI5vneZHVpLLmf2fx9vBlvBArh2yuY60lBQFujwx9ZqRKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXV86VMveVKN6bFBc1AViWY+a8zixARejUFEeswDbijtdg80oiA0iK7yixQBMmJp88csCWkz95KSaOQ=","type":"visacheckout"},{"name":"VVV Cadeaubon","paymentMethodData":"Ab02b4c0!BQABAgBuWnaPEjzVEB8\/NGLFT1i3XrlDJzrM+WNb\/Jlv5tb4pJctyyRwbUtHE+Yo+7v9XRANk4DGTuuMYL5BbaqbuUvs2k2JbgnlWHrqqcjA7cEz7EWRDEm2m4jWnMi\/KO5buk0BbQ+Ki\/7YNPsSkuCgUXGrIXAST5GRPzIwFYOS7M80DzlyKi8R7TdJAu8nsnpihktLBVOHBr9WrNRMe3S7p4Pd8a2HJGD\/CakIL9u7LXYhqYqgfkxfdvQrQFaz31p2xU9s\/o3kSWXT\/gnCJz5MuUhqXiudI9mNroS\/AYbUuSZIFFnuegd2t35BW4j8jzvgOZyoPRojqCGmAYUP6aAHShe6XB+7PN6dAIhJkLXznSpIKC1BtyUuG3HyUOwqFyKtt66E1\/ICJCmAAfiZkbJBFaSIUFnx1EM0hY7McaHS0+gfb1dQvBhJP\/fyBDpQAx6SaP2JAG9yivmzkH3+fMNoP6sxVyCX5EHnblAsXQEWxnJGZWWLzB218sox24jDHj01c7ZcADh4gowAJDZYsspaTgddheORCW12ovjADJFQKGMKEtpbFNVZ2TQl+mwBss0cvKspm2kGAPKWX0DjKa0HHvYnepEqAHwT6Qhe6PXORHbK\/3VcXdezEH8uyC6W9SsjsDO6GVKpWWItfOOfCqs\/\/3ViAbk6p72shjiFn4Lu7+B+HBCaAFBKqrM+zvXaV\/tH3eP\/AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVRLRyVt83jIBl71hMGKc7Aq0HNbfIAVFcPCegIt3jqjLySlfdxuP\/plZq3KB4f7vBdLHdqQ\/3WVzro=","type":"vvvcadeaubon"},{"name":"Webshop Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBw5gIZYWEh6Zd7RAM0RcpQNhnPRtUAHANn0tEb+FCguWnzFfqRV4thObH9oySVyjYp1vbALAAJGnkR+Xbm4KLf\/kWzz+MsMidMXC+FWs6hz8covVAtzRIIvEXlRBB17lLCeH9yJnWau96Xrm9l+yZgk0EchvtQoBmYeqSb4sQqJYkQdFQTTJHPAea6JrczKFcheU86s9QeSbzKxUOzI\/0ORulFOQXEsjk3Evm2fQ59KL3oBtcJF1GRJfcWQJ7zZ3JRhkyH9g1+Sbbfj1UYtsyl8d+CTDwFuqWmZyA39biI5VYXBW78id4DuOVKdzv\/Dv4zWy0dXDM3Voce0oZIRwQBC6lg5N2mw4RGAhp7IcUL+4DpZcrTOK4+ED24EmWrlpTusUkHNX\/SaV6Hs35PTK065jXtXmn++GvF5BzA4NTAn+shTTHCsl5sv9rhmmwx3+3BCzIj0cMAiFMTsVZ1Tx23+MnUXFIqkljRlyD07FnIXIbKeJoGtx6t+B9EKHCqEuJDnKWIEs+DnMRQzhiuaOh5n\/G0f06Q7FG6PYAKFGTe\/tw+GSKK6j71dYGgWycNzZeHW1sSNFVRL6pURb3S9RBMjOpeda3fUKChbIPqhjqF+wKl6q7XQvm+w4dKXHyhGI5DY\/9Vs\/DX74vRxcTtutZMhTGxI9JKmyYDQToFhwEKSxDXjdC8tIvsJDu7LQ8ve3nWAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQNrhANo5lS82O3KSvpHQtFHz\/w7XKDsG+sZhRsBQY+N+1Cc49e3d3xeejiToANWLbh9llsOy4hRUnTFUeI=","type":"webshopgiftcard"},{"name":"WE Fashion Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhMJIQ8zSZ6B6qQsbRyoLzMkLbJnIcfJHIMLS7tmbn3eRoZKTRWbey8PIxoyltacmUJkU9Hktzqrcczfx7UZdEmS5XumukT4NnlvUeLQ6iBNiTm0WNqDqgL8P8Vzpu+6GJsT41oxrPWQUnRIkh9ZBjqkq6Q+RVHJwsYTIdZpKGihaZlI3zNBgwSLs2LzlLnAqLARC5X93KvfNC9WifdaPentJQmmJUx0U6qu1Uj9a6sHB8GNNWBRZW7sV3HhSUR6Q\/FXYxZXmufRcqM9rYxIC\/Ju4EV2bJ+jLaoPpXu7PtOXiT39VGaZ0aX02gehuSgVQ4hjw1i7O6kjcKUm6PXXp0JYFeH02ysL6eUBuzi0ULP09PYg3CyFukvkec+RnmEQBAcWCQmzZ1orHgtCYXCwl43lI5c+NwO4mbNC0FL4f5Y\/UgDy79VFKUd5l3w8LwAEint4h21nMLKZYCJx1S1eCX5shzx+cCSd5GAqWUA77nXkUSwDBXXPmIp+GKQMkK7IFHgG9qTJ9rFvadF52PyEv4bsWcjeAyz6+CWOFBwk5TtEvSKDfKLAqU9+me9DfTP1QBY+FJYiBrOBW\/uBgv\/6NufzaDBWds4jJOVpo8S03\/yNCvM94DTJPIRfibEwGamM2qrERp86e1wjr0ao8B\/Zlc7ZX8QDzqDmpTCHT528mbuBDkq7A9lwTJVNkf2laeBxcqAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeYhP3EugLn\/D17cS8QOqpBIMSUWAoJfWN7rKm4sTQWjtXSso8521xeQzTTR3j4Lm4b1JeZiM3Bv46gVcq79Pw==","type":"wefashiongiftcard"},{"name":"Western Union","paymentMethodData":"Ab02b4c0!BQABAgCCqIHVjvWFfoO125G0Qi\/aWnkQVzmVVDCo+XpJXABFD4JEgSxsq2trLYLqxixmrJXEy\/e5RS1Y0KD2omwavOanQ0NWqkoerbCle+t1SAC3rpMYodSUhBAQluXCSvMRXNFrzFpxeK5+SzphqzTvgvLuMCN3Kyy4fBzCjXeMJwQB5o2DraGMt6w193\/\/nD\/kVGGexOhMfFNitRypd2g0ILs1S1O+rLOh2UYvEKczLbJ+xOqtCckSbE7t\/A28y+fowJxyqbDZFn\/Di1r+bK2Q+B+CvAcvdxbyrRJeJDQSvYI54rz\/2qk6DvzLS+yKu7uZmBaFsd8GF1Vc0CJWVeLZ1BF\/ShquUwXWWAwtaK3zYMy3C37QEJizTsOPwU8LgQ5xvzEn2W0h8+YrWqhAHnLLSfQv\/QyYlYuSa6MYcp0CfuC5Wxr0XQdHtDtdTDx0ixuCvG+bV8Tey6pEABFVDFLtRHhWWsDSlFJi35EMawzt9qBQ9ri2mIBjeoTZVmYNHHPoQSU7lTupadcQnPauOy0gTc98ChXlDQaYIxgXjoVHoQulaayi5+HDNFH6FgJEltb7+vZ1chT83KDM32bigFtQjob+vb7uArSqC1QZofwA4brnBmitCTuFFsWEf93x9kzru5cFKnZZCu6LYeFBqifpRDnTM+8OcmKjXXUv4OpzUKy6hxDOyQJZ+vzZMa5eASNa1ISYAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTr1ArwVsfDs6+p1vy4hzFpiQEO1qZlAmr0hJBKvgtDG\/ormHk1hx5CoFvjgKJj\/g9ORllgYAkavtqg=","type":"westernunion"},{"name":"Winkel Cheque","paymentMethodData":"Ab02b4c0!BQABAgAuGTr7Hb+sS9WhMaJbxMJQhXv9kpCTqWbc+RpEEcDBam1sWPzqrAWeyEpqPp5t0Ts94E3zW7RTJ0AyEvhVS+KpGQKn+EI7jt0liVbDaqFAG87xZdNdtFVXlfBwMk4DLWgr1QOYW1AABoVcVV1+Mq2hL\/8sv29dh9ORkTf8fFv6BuEGFoEc+Yze7k5gLXnLrRkiBVh7WhpZR6TXMZvebgAjBQ26W0erUSTjzzs4bVl5ZqsULqmHmjj9ZrI+MZ2c4orYMK8SJXb+qKZ697NGEazsyMZZRmOG5NBYzOEjdK9\/SdnabgRgqxAWhy3nSQfqNgVArpvfivFbup14x\/ZM\/P2P6xBFyNyK0v5PN2k9f3gFEUtvM0Yz3zj2p9qAw66U6+ug38u3luiIwLHXFv8Mg87ELftuOJwruAYurvCqyvDBY0j3qgBb8fa3A6EULfXU35V0hVo6r9SHW3efvsocd6vjKQogZP2Tgf4e++kIF81n1w39xSPaTaSHNnc9HEtFcEMrgkmFlm7+MWAIf14xWi+jDdPtJtbSkFE\/lDqxsyE16axJ+nCZ2914Eiplrs6Fmq\/f3T0QXQGXsZwTXMwZV8ubAa5xv5Sowoi2ZGVzDFRhqxK3PfdQIVNyS\/U0zqDTJ8Dco+0DnlPfS+\/S3dLHixJzJDJegh1\/cy10Vz8QUrBzpRBOKwDnktP8pBxNeO0dVr0nAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTRFBBd7HtMO30hv\/1qeyRVC\/ySeAXdYL++1P5WngYLi293p32vLL19uakeOYJbh0acNqVNS9uERfhQ=","type":"winkelcheque"},{"name":"Your Gift","paymentMethodData":"Ab02b4c0!BQABAgBwSzkAZFP62rf9A9s1eTR5eZelvAMGdp75eyxk2\/054VREmax\/NX6bgGYg6hvpRuE78ATV0+9jI4LcwHKCMuXsZWWqj9Ro7hddiMuc1ZDOVmCAchKVnlR3X1R4I8eb4U+plSY5C31VqDBC+tGAdsQjm44Y0e9e\/W4kF6SVU7UIvh8\/ts8McsFMcBNc\/gvQ\/fTTSgLyjghJaDc\/1J9ZFkgtVgAoTSqgziytCwx9J5dV2urWfAX3sIKyI4tIMgH7C2zOvdE2W6woJlxuMC\/bhxUmt9zM9RUWJVzkwaVKpo7RCQzquoSpO3M+koHb+kLLp11XEk4MMV7jVbqLYl4dOS5iP9kzcce0hx+SADNlENxL14W9EHHODaQaeSPrueBGlf4l8GZMny3IQv9UzmSS\/xWvq7lOPov1uFyJKXFI2jILR2dGA6FK1+CSuqlR\/nkyQcQo2XFufYi9g2HatTFfd4MXkUSHF4\/TpdFAd8AshyabLjhOmjbXZG1zukWW3o8Lo6\/rELOloFpQpdadsXb0M5vZVkrzKIIjHoY+EvGB1urnbZNKUzah2W+2chqSC69INtIcGj1M7r0Tt8EaMg4DVAKMXsMnYRIwp2h7g1NiWvNcEgENUCDpuuWENa09yA4siPR9aWcLm9nukW\/TT46erTG3VMhKF++tVp+GFBeFTr83XBDPsKLjXgj3XpGkvhHlmDFKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifa+nTY4wbmTCGTsoOuYLTfMGaYM7Hyyz7AXsLTj951IZvDN7doNuKw2PdTY9Ed17dTickZ0Akw==","type":"yourgift"}],"publicKey":"10001|BDF03F216DE358DD6AB214B74BF0F8BFDCDA9F3EEE0B369DC5ADBCBE0FFAB2A4FA1E31C49519BCBC7241824EE45F7ACC5B04123446D105B713135897F6CBC82C478DF3B26FCC0DEDDFE8BD2F29DBAF35AE66ECE6AFE48C985A08591CDC57EA2B35F2551CDEEFD3ACFB912E0530B402549399C93C2C23CF74C444515FC6A6E5D267A4A2E51CA97F304608FB564DE70E1D683CBDAFD7E869123C91962380D38AF740033D52DC2523DA80CE72097D2ED7D1CAE33B60C91AC2F6307795808D2D351FD112C283E043F1B266C2C347DEE31EE8D606D512431BC5C9C01099A967532EFA06698F130AF5005ECE0CEE3FFAC24884E2C7F6FCD48666D64D40056CCBE62579","sdkVersion":"1.3.0"}\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.3.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.3.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -598,56 +1045,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"authResponse\" : \"Authorised\",\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -660,55 +1166,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -716,56 +1280,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -773,106 +1396,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -885,56 +1627,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -942,55 +1743,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1003,104 +1862,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1113,104 +2032,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1218,153 +2254,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1372,447 +2584,749 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"donationToken\" : \"81234567890123456...\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] - } -, + }, { "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. ", @@ -1820,56 +3334,115 @@ { "name": "Submit details for the 3D Secure payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"Authorised\",\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1882,55 +3455,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -1938,49 +3569,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -1988,55 +3620,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v40.json b/postman/CheckoutService-v40.json index 5f87f93..c091901 100644 --- a/postman/CheckoutService-v40.json +++ b/postman/CheckoutService-v40.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.3.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.3.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.3.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,692 +2692,1118 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8315791039321763\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8315791039321763\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"donationToken\" : \"81234567890123456...\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] - } -, + }, { "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. ", @@ -2114,56 +3811,115 @@ { "name": "Submit details for the 3D Secure payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"Authorised\",\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -2176,55 +3932,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2232,49 +4046,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2282,55 +4097,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v41.json b/postman/CheckoutService-v41.json index 68af6ca..54b74a1 100644 --- a/postman/CheckoutService-v41.json +++ b/postman/CheckoutService-v41.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,790 +2692,1277 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"street\" : \"Haarlem\",\n \"city\" : \"New York\",\n \"houseNumberOrName\" : \"37\",\n \"stateOrProvince\" : \"CA\",\n \"postalCode\" : \"10BA\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"street\" : \"Haarlem\",\n \"city\" : \"New York\",\n \"houseNumberOrName\" : \"37\",\n \"stateOrProvince\" : \"CA\",\n \"postalCode\" : \"10BA\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"street\" : \"Haarlem\",\n \"city\" : \"New York\",\n \"houseNumberOrName\" : \"37\",\n \"stateOrProvince\" : \"CA\",\n \"postalCode\" : \"10BA\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8315791039321763\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8315791039321763\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"donationToken\" : \"81234567890123456...\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] - } -, + }, { "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. ", @@ -2212,206 +3970,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2424,55 +4189,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2480,49 +4303,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2530,55 +4354,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v46.json b/postman/CheckoutService-v46.json index 010c157..75973a1 100644 --- a/postman/CheckoutService-v46.json +++ b/postman/CheckoutService-v46.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,790 +2692,1277 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4917610000000000\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"holderName\" : \"John Smith\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4917610000000000\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"holderName\" : \"John Smith\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4917610000000000\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"holderName\" : \"John Smith\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8315791039321763\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8315791039321763\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"donationToken\" : \"81234567890123456...\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] - } -, + }, { "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. ", @@ -2212,206 +3970,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2424,55 +4189,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2480,49 +4303,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2530,55 +4354,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v49.json b/postman/CheckoutService-v49.json index 00c3296..2a33530 100644 --- a/postman/CheckoutService-v49.json +++ b/postman/CheckoutService-v49.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,790 +2692,1277 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"donationToken\" : \"81234567890123456...\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] - } -, + }, { "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. ", @@ -2212,206 +3970,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2424,55 +4189,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2480,49 +4303,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2530,55 +4354,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v50.json b/postman/CheckoutService-v50.json index db1e6a3..642f4f3 100644 --- a/postman/CheckoutService-v50.json +++ b/postman/CheckoutService-v50.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,839 +2692,1385 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"donationToken\" : \"81234567890123456...\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"004908\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9UV722\"\n },\n \"pspReference\" : \"993617895153552A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2261,206 +4078,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2473,55 +4297,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2529,49 +4411,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2579,55 +4462,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v51.json b/postman/CheckoutService-v51.json index 9b1306a..69a9d23 100644 --- a/postman/CheckoutService-v51.json +++ b/postman/CheckoutService-v51.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,839 +2692,1385 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"donationToken\" : \"81234567890123456...\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"004908\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9UV722\"\n },\n \"pspReference\" : \"993617895153552A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2261,206 +4078,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2473,55 +4297,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2529,49 +4411,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2579,55 +4462,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v52.json b/postman/CheckoutService-v52.json index 17e7232..54d1221 100644 --- a/postman/CheckoutService-v52.json +++ b/postman/CheckoutService-v52.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,839 +2692,1385 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"donationToken\" : \"81234567890123456...\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"004908\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9UV722\"\n },\n \"pspReference\" : \"993617895153552A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2261,206 +4078,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2473,55 +4297,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2529,49 +4411,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2579,55 +4462,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v53.json b/postman/CheckoutService-v53.json index 5938126..1ed4519 100644 --- a/postman/CheckoutService-v53.json +++ b/postman/CheckoutService-v53.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,839 +2692,1385 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"donationToken\" : \"81234567890123456...\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"004908\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9UV722\"\n },\n \"pspReference\" : \"993617895153552A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2261,206 +4078,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2473,55 +4297,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2529,49 +4411,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2579,55 +4462,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v64.json b/postman/CheckoutService-v64.json index 67d1c83..1def0d2 100644 --- a/postman/CheckoutService-v64.json +++ b/postman/CheckoutService-v64.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,839 +2692,1385 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"donationToken\" : \"81234567890123456...\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"004908\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9UV722\"\n },\n \"pspReference\" : \"993617895153552A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2261,206 +4078,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2473,55 +4297,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2529,49 +4411,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2579,55 +4462,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v65.json b/postman/CheckoutService-v65.json index f76142d..692dcfa 100644 --- a/postman/CheckoutService-v65.json +++ b/postman/CheckoutService-v65.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ],\n \"storedPaymentMethods\" : [ {\n \"brand\" : \"visa\",\n \"expiryMonth\" : \"10\",\n \"expiryYear\" : \"30\",\n \"holderName\" : \"John Smith\",\n \"id\" : \"7219687191761347\",\n \"issuerName\" : \"ISSUER_NAME\",\n \"lastFour\" : \"1111\",\n \"name\" : \"VISA\",\n \"shopperEmail\" : \"john.smith@example.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"supportedRecurringProcessingModels\" : [ \"CardOnFile\", \"Subscription\", \"UnscheduledCardOnFile\" ],\n \"type\" : \"scheme\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,839 +2692,1385 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"donationToken\" : \"81234567890123456...\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"004908\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9UV722\"\n },\n \"pspReference\" : \"993617895153552A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2261,206 +4078,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2473,55 +4297,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2529,49 +4411,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2579,55 +4462,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v66.json b/postman/CheckoutService-v66.json index 73e84a5..9c6e0de 100644 --- a/postman/CheckoutService-v66.json +++ b/postman/CheckoutService-v66.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ],\n \"storedPaymentMethods\" : [ {\n \"brand\" : \"visa\",\n \"expiryMonth\" : \"10\",\n \"expiryYear\" : \"30\",\n \"holderName\" : \"John Smith\",\n \"id\" : \"7219687191761347\",\n \"issuerName\" : \"ISSUER_NAME\",\n \"lastFour\" : \"1111\",\n \"name\" : \"VISA\",\n \"shopperEmail\" : \"john.smith@example.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"supportedRecurringProcessingModels\" : [ \"CardOnFile\", \"Subscription\", \"UnscheduledCardOnFile\" ],\n \"type\" : \"scheme\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,839 +2692,1385 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044410\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9TI1O2\"\n },\n \"pspReference\" : \"993617895005515H\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4917610000000000\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"accountInfo\" : {\n \"accountCreationDate\" : \"2019-01-17T13:42:40+01:00\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"074516\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJ7DN\"\n },\n \"pspReference\" : \"993617894903480A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"colorDepth\" : 24,\n \"screenHeight\" : 1800,\n \"screenWidth\" : 2880,\n \"timeZoneOffset\" : 60,\n \"language\" : \"nl\",\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"083996\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJH66\"\n },\n \"pspReference\" : \"993617894905481G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4212345678901237\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"036240\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SJQUL\"\n },\n \"pspReference\" : \"993617894906488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"064649\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9SM92L\"\n },\n \"pspReference\" : \"993617894914488A\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"022966\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9T0BB6\"\n },\n \"pspReference\" : \"993617894947495G\",\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"details\" : [ {\n \"key\" : \"payload\",\n \"type\" : \"text\"\n } ],\n \"paymentData\" : \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"donationToken\" : \"81234567890123456...\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"004908\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9UV722\"\n },\n \"pspReference\" : \"993617895153552A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2261,206 +4078,213 @@ { "name": "Submit details for the 3D Secure payment ", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Hee57361f99....\",\n \"details\" : {\n \"MD\" : \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\" : \"eNrNV0mTo7gS...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 callenge flow result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.challengeResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit 3D Secure 2 device fingerprinting result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeds2.fingerprint\" : \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n },\n \"paymentData\" : \"YOUR_PAYMENT_DATA...\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\" : \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2473,55 +4297,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2529,49 +4411,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2579,55 +4462,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v67.json b/postman/CheckoutService-v67.json index 3b8b4f0..7a627b1 100644 --- a/postman/CheckoutService-v67.json +++ b/postman/CheckoutService-v67.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankLocationId\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"bankAccountNumber\",\n \"type\" : \"text\"\n } ],\n \"key\" : \"bankAccount\",\n \"type\" : \"bankAccount\"\n } ],\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"AUB_DIRECT\",\n \"name\" : \"AU Small Finance Bank\"\n }, {\n \"id\" : \"ALB_DIRECT\",\n \"name\" : \"Allahabad Bank \"\n }, {\n \"id\" : \"APG_DIRECT\",\n \"name\" : \"Andhra Pragathi Grameena Bank\"\n }, {\n \"id\" : \"BDN_DIRECT\",\n \"name\" : \"Bandhan bank\"\n }, {\n \"id\" : \"BBK_DIRECT\",\n \"name\" : \"Bank of Bahrain and Kuwait\"\n }, {\n \"id\" : \"BBR_DIRECT\",\n \"name\" : \"Bank of Baroda - Retail Banking\"\n }, {\n \"id\" : \"BCB_DIRECT\",\n \"name\" : \"Bassien Catholic Co-Operative Bank \"\n }, {\n \"id\" : \"CNB_DIRECT\",\n \"name\" : \"Canara Bank\"\n }, {\n \"id\" : \"SYD_DIRECT\",\n \"name\" : \"Canara Bank (e-Syndicate)\"\n }, {\n \"id\" : \"CSB_DIRECT\",\n \"name\" : \"Catholic Syrian Bank\"\n }, {\n \"id\" : \"CBI_DIRECT\",\n \"name\" : \"Central Bank of India\"\n }, {\n \"id\" : \"CUB_DIRECT\",\n \"name\" : \"City Union Bank\"\n }, {\n \"id\" : \"COB_DIRECT\",\n \"name\" : \"Cosmos Bank\"\n }, {\n \"id\" : \"DEN_DIRECT\",\n \"name\" : \"Dena Bank\"\n }, {\n \"id\" : \"DBK_DIRECT\",\n \"name\" : \"Deutsche Bank\"\n }, {\n \"id\" : \"DCB_DIRECT\",\n \"name\" : \"Development Credit Bank\"\n }, {\n \"id\" : \"DLB_DIRECT\",\n \"name\" : \"Dhanlakshmi Bank - Retail Net Banking\"\n }, {\n \"id\" : \"ESF_DIRECT\",\n \"name\" : \"ESAF Small Finance Bank\"\n }, {\n \"id\" : \"EQB_DIRECT\",\n \"name\" : \"Equitas Small Finance Bank\"\n }, {\n \"id\" : \"FBK_DIRECT\",\n \"name\" : \"Federal Bank\"\n }, {\n \"id\" : \"FNC_DIRECT\",\n \"name\" : \"Fincare Bank\"\n }, {\n \"id\" : \"HDF_DIRECT\",\n \"name\" : \"HDFC Bank\"\n }, {\n \"id\" : \"ICI_DIRECT\",\n \"name\" : \"ICICI Bank \"\n }, {\n \"id\" : \"IDB_DIRECT\",\n \"name\" : \"IDBI Bank - Retail Net Banking\"\n }, {\n \"id\" : \"IDN_DIRECT\",\n \"name\" : \"IDFC FIRST Bank\"\n }, {\n \"id\" : \"INB_DIRECT\",\n \"name\" : \"Indian Bank\"\n }, {\n \"id\" : \"IOB_DIRECT\",\n \"name\" : \"Indian Overseas Bank\"\n }, {\n \"id\" : \"IDS_DIRECT\",\n \"name\" : \"IndusInd Bank\"\n }, {\n \"id\" : \"JKB_DIRECT\",\n \"name\" : \"Jammu & Kashmir Bank\"\n }, {\n \"id\" : \"JNB_DIRECT\",\n \"name\" : \"Jana Small Finance Bank\"\n }, {\n \"id\" : \"JSB_DIRECT\",\n \"name\" : \"Janata Sahakari Bank Ltd Pune\"\n }, {\n \"id\" : \"KJB_DIRECT\",\n \"name\" : \"Kalyan Janata Sahakari Bank\"\n }, {\n \"id\" : \"KBL_DIRECT\",\n \"name\" : \"Karnataka Bank Ltd\"\n }, {\n \"id\" : \"KVB_DIRECT\",\n \"name\" : \"Karur Vysya Bank\"\n }, {\n \"id\" : \"162_DIRECT\",\n \"name\" : \"Kotak Bank\"\n }, {\n \"id\" : \"LVR_DIRECT\",\n \"name\" : \"Laxmi Vilas Bank - Retail\"\n }, {\n \"id\" : \"NKB_DIRECT\",\n \"name\" : \"NKGSB Co-op Bank\"\n }, {\n \"id\" : \"NEB_DIRECT\",\n \"name\" : \"North East Small Finance Bank\"\n }, {\n \"id\" : \"OBC_DIRECT\",\n \"name\" : \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n }, {\n \"id\" : \"UNI_DIRECT\",\n \"name\" : \"PNB (Erstwhile-United Bank of India)\"\n }, {\n \"id\" : \"PMC_DIRECT\",\n \"name\" : \"Punjab & Maharastra Co-op Bank\"\n }, {\n \"id\" : \"PSB_DIRECT\",\n \"name\" : \"Punjab & Sind Bank\"\n }, {\n \"id\" : \"CPN_DIRECT\",\n \"name\" : \"Punjab National Bank - Corporate \"\n }, {\n \"id\" : \"PNB_DIRECT\",\n \"name\" : \"Punjab National Bank - Retail Banking\"\n }, {\n \"id\" : \"RBL_DIRECT\",\n \"name\" : \"RBL Bank Limited\"\n }, {\n \"id\" : \"SWB_DIRECT\",\n \"name\" : \"Saraswat Bank\"\n }, {\n \"id\" : \"SHB_DIRECT\",\n \"name\" : \"Shivalik Mercantile Cooperative Bank Ltd\"\n }, {\n \"id\" : \"SIB_DIRECT\",\n \"name\" : \"South Indian Bank\"\n }, {\n \"id\" : \"SCB_DIRECT\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"SBI_DIRECT\",\n \"name\" : \"State Bank of India\"\n }, {\n \"id\" : \"SRB_DIRECT\",\n \"name\" : \"Suryoday Small Finance Bank\"\n }, {\n \"id\" : \"TJB_DIRECT\",\n \"name\" : \"TJSB Bank\"\n }, {\n \"id\" : \"TNC_DIRECT\",\n \"name\" : \"Tamil Nadu State Co-operative Bank\"\n }, {\n \"id\" : \"TMB_DIRECT\",\n \"name\" : \"Tamilnad Mercantile Bank Ltd\"\n }, {\n \"id\" : \"TBB_DIRECT\",\n \"name\" : \"Thane Bharat Sahakari Bank Ltd\"\n }, {\n \"id\" : \"MSB_DIRECT\",\n \"name\" : \"The Mehsana Urban Co Op Bank Ltd\"\n }, {\n \"id\" : \"UCO_DIRECT\",\n \"name\" : \"UCO Bank\"\n }, {\n \"id\" : \"UBI_DIRECT\",\n \"name\" : \"Union Bank of India\"\n }, {\n \"id\" : \"ADB_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Andhra Bank)\"\n }, {\n \"id\" : \"CRP_DIRECT\",\n \"name\" : \"Union Bank of India (Erstwhile Corporation Bank)\"\n }, {\n \"id\" : \"VRB_DIRECT\",\n \"name\" : \"Varachha Co-operative Bank Limited\"\n }, {\n \"id\" : \"VJB_DIRECT\",\n \"name\" : \"Vijaya Bank\"\n }, {\n \"id\" : \"YBK_DIRECT\",\n \"name\" : \"Yes Bank\"\n }, {\n \"id\" : \"ZOB_DIRECT\",\n \"name\" : \"Zoroastrian Co-operative Bank Limited\"\n }, {\n \"id\" : \"DBS_DIRECT\",\n \"name\" : \"digibank by DBS\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"DCW_DIRECT\",\n \"name\" : \"DCB Cippy\"\n }, {\n \"id\" : \"ICC_DIRECT\",\n \"name\" : \"ICC Cash Card\"\n }, {\n \"id\" : \"OXY_DIRECT\",\n \"name\" : \"Oxigen Wallet\"\n }, {\n \"id\" : \"PCH_DIRECT\",\n \"name\" : \"Pay World Money\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"details\" : [ {\n \"key\" : \"ovoId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"infix\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"66\",\n \"name\" : \"Bank Nowy BFG S.A.\"\n }, {\n \"id\" : \"92\",\n \"name\" : \"Bank Spółdzielczy w Brodnicy\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Bank transfer / postal\"\n }, {\n \"id\" : \"74\",\n \"name\" : \"Banki Spółdzielcze\"\n }, {\n \"id\" : \"73\",\n \"name\" : \"BLIK\"\n }, {\n \"id\" : \"90\",\n \"name\" : \"BNP Paribas - płacę z Pl@net\"\n }, {\n \"id\" : \"59\",\n \"name\" : \"CinkciarzPAY\"\n }, {\n \"id\" : \"87\",\n \"name\" : \"Credit Agricole PBL\"\n }, {\n \"id\" : \"83\",\n \"name\" : \"EnveloBank\"\n }, {\n \"id\" : \"76\",\n \"name\" : \"Getin Bank PBL\"\n }, {\n \"id\" : \"81\",\n \"name\" : \"Idea Cloud\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"ING Corporate customers\"\n }, {\n \"id\" : \"93\",\n \"name\" : \"Kasa Stefczyka\"\n }, {\n \"id\" : \"44\",\n \"name\" : \"Millennium - Płatności Internetowe\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Millennium Corporate customers\"\n }, {\n \"id\" : \"68\",\n \"name\" : \"mRaty\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"mTransfer\"\n }, {\n \"id\" : \"91\",\n \"name\" : \"Nest Bank\"\n }, {\n \"id\" : \"80\",\n \"name\" : \"Noble Pay\"\n }, {\n \"id\" : \"50\",\n \"name\" : \"Pay Way Toyota Bank\"\n }, {\n \"id\" : \"45\",\n \"name\" : \"Pay with Alior Bank\"\n }, {\n \"id\" : \"36\",\n \"name\" : \"Pekao24Przelew\"\n }, {\n \"id\" : \"70\",\n \"name\" : \"Pocztowy24\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Przelew24\"\n }, {\n \"id\" : \"46\",\n \"name\" : \"Płacę z Citi Handlowy\"\n }, {\n \"id\" : \"38\",\n \"name\" : \"Płacę z ING\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Płacę z Inteligo\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Płacę z iPKO\"\n }, {\n \"id\" : \"75\",\n \"name\" : \"Płacę z Plus Bank\"\n }, {\n \"id\" : \"51\",\n \"name\" : \"Płać z BOŚ\"\n }, {\n \"id\" : \"55\",\n \"name\" : \"Raty z Alior Bankiem PLN\"\n }, {\n \"id\" : \"89\",\n \"name\" : \"Santander\"\n }, {\n \"id\" : \"52\",\n \"name\" : \"SkyCash\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"231\",\n \"name\" : \"POP Pankki\"\n }, {\n \"id\" : \"551\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"232\",\n \"name\" : \"Aktia\"\n }, {\n \"id\" : \"552\",\n \"name\" : \"Raiffeisen\"\n }, {\n \"id\" : \"233\",\n \"name\" : \"Säästöpankki\"\n }, {\n \"id\" : \"750\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"211\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"553\",\n \"name\" : \"ČSOB\"\n }, {\n \"id\" : \"234\",\n \"name\" : \"S-Pankki\"\n }, {\n \"id\" : \"751\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"554\",\n \"name\" : \"Moneta\"\n }, {\n \"id\" : \"235\",\n \"name\" : \"OmaSP\"\n }, {\n \"id\" : \"752\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"213\",\n \"name\" : \"Op-Pohjola\"\n }, {\n \"id\" : \"555\",\n \"name\" : \"UniCredit\"\n }, {\n \"id\" : \"753\",\n \"name\" : \"LHV\"\n }, {\n \"id\" : \"556\",\n \"name\" : \"Fio\"\n }, {\n \"id\" : \"557\",\n \"name\" : \"mBank\"\n }, {\n \"id\" : \"216\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"558\",\n \"name\" : \"Air Bank\"\n }, {\n \"id\" : \"260\",\n \"name\" : \"Länsförsäkringar\"\n }, {\n \"id\" : \"240\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"265\",\n \"name\" : \"Sparbanken\"\n }, {\n \"id\" : \"640\",\n \"name\" : \"BankDeposit\"\n }, {\n \"id\" : \"200\",\n \"name\" : \"Ålandsbanken\"\n }, {\n \"id\" : \"940\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"500\",\n \"name\" : \"Česká spořitelna\"\n }, {\n \"id\" : \"720\",\n \"name\" : \"Swedbank\"\n }, {\n \"id\" : \"941\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"204\",\n \"name\" : \"Danske Bank\"\n }, {\n \"id\" : \"721\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"942\",\n \"name\" : \"Citadele\"\n }, {\n \"id\" : \"205\",\n \"name\" : \"Handelsbanken\"\n }, {\n \"id\" : \"722\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"943\",\n \"name\" : \"DNB\"\n }, {\n \"id\" : \"206\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"723\",\n \"name\" : \"Šiaulių bankas\"\n }, {\n \"id\" : \"207\",\n \"name\" : \"SEB\"\n }, {\n \"id\" : \"724\",\n \"name\" : \"Nordea\"\n }, {\n \"id\" : \"505\",\n \"name\" : \"Komerční banka\"\n }, {\n \"id\" : \"208\",\n \"name\" : \"Skandiabanken\"\n }, {\n \"id\" : \"209\",\n \"name\" : \"Swedbank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\" : \"Dolomitenbank\"\n }, {\n \"id\" : \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\" : \"Raiffeissen Bankengruppe\"\n }, {\n \"id\" : \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\" : \"Hypo Tirol Bank AG\"\n }, {\n \"id\" : \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\" : \"Sparda Bank Wien\"\n }, {\n \"id\" : \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\" : \"Schoellerbank AG\"\n }, {\n \"id\" : \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\" : \"Volksbank Gruppe\"\n }, {\n \"id\" : \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\" : \"Immo-Bank\"\n }, {\n \"id\" : \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\" : \"Bank Austria\"\n }, {\n \"id\" : \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\" : \"Easybank AG\"\n }, {\n \"id\" : \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\" : \"VR-BankBraunau\"\n }, {\n \"id\" : \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\" : \"Volkskreditbank\"\n }, {\n \"id\" : \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\" : \"Erste Bank und Sparkassen\"\n }, {\n \"id\" : \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\" : \"BAWAG P.S.K. Gruppe\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"FR\",\n \"name\" : \"France\"\n }, {\n \"id\" : \"ES\",\n \"name\" : \"Spain\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"4031000\",\n \"name\" : \"Bank of Beijing\"\n }, {\n \"id\" : \"01040000\",\n \"name\" : \"Bank of China\"\n }, {\n \"id\" : \"03020000\",\n \"name\" : \"China Citic Bank\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03030000\",\n \"name\" : \"China Everbright Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"03050000\",\n \"name\" : \"China Minsheng Banking Group\"\n }, {\n \"id\" : \"03040000\",\n \"name\" : \"Hua Xia Bank Co\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03070000\",\n \"name\" : \"PingAn Bank\"\n }, {\n \"id\" : \"1000000\",\n \"name\" : \"Postal Savings Bank of China\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"01030000\",\n \"name\" : \"Agricultural Bank of China\"\n }, {\n \"id\" : \"01050000\",\n \"name\" : \"China Construction Bank\"\n }, {\n \"id\" : \"03080000\",\n \"name\" : \"China Merchants Bank\"\n }, {\n \"id\" : \"01020000\",\n \"name\" : \"Industrial and Commercial Bank of China\"\n }, {\n \"id\" : \"03100000\",\n \"name\" : \"Shanghai Pudong Development Bank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n } ],\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"details\" : [ {\n \"key\" : \"shopper.firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.lastName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopper.gender\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"countryCode\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"vtcpay-vietinbank\",\n \"name\" : \"Vietinbank\"\n }, {\n \"id\" : \"vtcpay-bidv\",\n \"name\" : \"BIDV\"\n }, {\n \"id\" : \"vtcpay-agribank\",\n \"name\" : \"Agribank\"\n }, {\n \"id\" : \"vtcpay-mb\",\n \"name\" : \"MB Bank\"\n }, {\n \"id\" : \"vtcpay-sacombank\",\n \"name\" : \"Sacombank\"\n }, {\n \"id\" : \"vtcpay-dongabank\",\n \"name\" : \"DongABank\"\n }, {\n \"id\" : \"vtcpay-maritimebank\",\n \"name\" : \"MaritimeBank\"\n }, {\n \"id\" : \"vtcpay-vietcombank\",\n \"name\" : \"Vietcombank\"\n }, {\n \"id\" : \"vtcpay-acb\",\n \"name\" : \"ACB\"\n }, {\n \"id\" : \"vtcpay-techcombank\",\n \"name\" : \"Techcombank\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"fpx_bimb\",\n \"name\" : \"Bank Islam\"\n }, {\n \"id\" : \"fpx_uob\",\n \"name\" : \"UOB Bank\"\n }, {\n \"id\" : \"fpx_cimbclicks\",\n \"name\" : \"CIMB Clicks\"\n }, {\n \"id\" : \"fpx_kfh\",\n \"name\" : \"Kuwait Finance House\"\n }, {\n \"id\" : \"fpx_rhb\",\n \"name\" : \"RHB Now\"\n }, {\n \"id\" : \"fpx_abmb\",\n \"name\" : \"Alliance Bank\"\n }, {\n \"id\" : \"fpx_amb\",\n \"name\" : \"Am Online\"\n }, {\n \"id\" : \"fpx_hsbc\",\n \"name\" : \"HSBC\"\n }, {\n \"id\" : \"fpx_abb\",\n \"name\" : \"Affin Bank\"\n }, {\n \"id\" : \"fpx_ocbc\",\n \"name\" : \"OCBC Bank\"\n }, {\n \"id\" : \"fpx_pbb\",\n \"name\" : \"Public Bank\"\n }, {\n \"id\" : \"fpx_scb\",\n \"name\" : \"Standard Chartered Bank\"\n }, {\n \"id\" : \"fpx_bsn\",\n \"name\" : \"Bank Simpanan Nasional\"\n }, {\n \"id\" : \"fpx_mb2u\",\n \"name\" : \"Maybank2u\"\n }, {\n \"id\" : \"fpx_hlb\",\n \"name\" : \"Hong Leong Connect\"\n }, {\n \"id\" : \"fpx_bmmb\",\n \"name\" : \"Bank Muamalat\"\n }, {\n \"id\" : \"fpx_bkrm\",\n \"name\" : \"Bank Rakyat\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1\",\n \"name\" : \"Model Bank v2\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"+7\",\n \"name\" : \"RU\"\n }, {\n \"id\" : \"+9955\",\n \"name\" : \"GE\"\n }, {\n \"id\" : \"+507\",\n \"name\" : \"PA\"\n }, {\n \"id\" : \"+44\",\n \"name\" : \"GB\"\n }, {\n \"id\" : \"+992\",\n \"name\" : \"TJ\"\n }, {\n \"id\" : \"+370\",\n \"name\" : \"LT\"\n }, {\n \"id\" : \"+972\",\n \"name\" : \"IL\"\n }, {\n \"id\" : \"+996\",\n \"name\" : \"KG\"\n }, {\n \"id\" : \"+380\",\n \"name\" : \"UA\"\n }, {\n \"id\" : \"+84\",\n \"name\" : \"VN\"\n }, {\n \"id\" : \"+90\",\n \"name\" : \"TR\"\n }, {\n \"id\" : \"+994\",\n \"name\" : \"AZ\"\n }, {\n \"id\" : \"+374\",\n \"name\" : \"AM\"\n }, {\n \"id\" : \"+371\",\n \"name\" : \"LV\"\n }, {\n \"id\" : \"+91\",\n \"name\" : \"IN\"\n }, {\n \"id\" : \"+66\",\n \"name\" : \"TH\"\n }, {\n \"id\" : \"+373\",\n \"name\" : \"MD\"\n }, {\n \"id\" : \"+1\",\n \"name\" : \"US\"\n }, {\n \"id\" : \"+81\",\n \"name\" : \"JP\"\n }, {\n \"id\" : \"+998\",\n \"name\" : \"UZ\"\n }, {\n \"id\" : \"+77\",\n \"name\" : \"KZ\"\n }, {\n \"id\" : \"+375\",\n \"name\" : \"BY\"\n }, {\n \"id\" : \"+372\",\n \"name\" : \"EE\"\n }, {\n \"id\" : \"+40\",\n \"name\" : \"RO\"\n }, {\n \"id\" : \"+82\",\n \"name\" : \"KR\"\n } ],\n \"key\" : \"qiwiwallet.telephoneNumberPrefix\",\n \"type\" : \"select\"\n }, {\n \"key\" : \"qiwiwallet.telephoneNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"virtualPaymentAddress\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"telephoneNumber\",\n \"optional\" : true,\n \"type\" : \"tel\"\n } ],\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"details\" : [ {\n \"items\" : [ {\n \"id\" : \"1121\",\n \"name\" : \"Test Issuer\"\n }, {\n \"id\" : \"1154\",\n \"name\" : \"Test Issuer 5\"\n }, {\n \"id\" : \"1153\",\n \"name\" : \"Test Issuer 4\"\n }, {\n \"id\" : \"1152\",\n \"name\" : \"Test Issuer 3\"\n }, {\n \"id\" : \"1151\",\n \"name\" : \"Test Issuer 2\"\n }, {\n \"id\" : \"1162\",\n \"name\" : \"Test Issuer Cancelled\"\n }, {\n \"id\" : \"1161\",\n \"name\" : \"Test Issuer Pending\"\n }, {\n \"id\" : \"1160\",\n \"name\" : \"Test Issuer Refused\"\n }, {\n \"id\" : \"1159\",\n \"name\" : \"Test Issuer 10\"\n }, {\n \"id\" : \"1158\",\n \"name\" : \"Test Issuer 9\"\n }, {\n \"id\" : \"1157\",\n \"name\" : \"Test Issuer 8\"\n }, {\n \"id\" : \"1156\",\n \"name\" : \"Test Issuer 7\"\n }, {\n \"id\" : \"1155\",\n \"name\" : \"Test Issuer 6\"\n } ],\n \"key\" : \"issuer\",\n \"type\" : \"select\"\n } ],\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"details\" : [ {\n \"key\" : \"encryptedCardNumber\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedSecurityCode\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryMonth\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"encryptedExpiryYear\",\n \"type\" : \"cardToken\"\n }, {\n \"key\" : \"holderName\",\n \"optional\" : true,\n \"type\" : \"text\"\n } ],\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"details\" : [ {\n \"details\" : [ {\n \"key\" : \"firstName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"lastName\",\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"M\",\n \"name\" : \"male\"\n }, {\n \"id\" : \"F\",\n \"name\" : \"female\"\n } ],\n \"key\" : \"gender\",\n \"type\" : \"radio\"\n }, {\n \"key\" : \"dateOfBirth\",\n \"type\" : \"date\"\n }, {\n \"key\" : \"telephoneNumber\",\n \"type\" : \"tel\"\n }, {\n \"key\" : \"shopperEmail\",\n \"type\" : \"emailAddress\"\n } ],\n \"key\" : \"personalDetails\",\n \"type\" : \"fieldSet\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"billingAddress\",\n \"type\" : \"address\"\n }, {\n \"key\" : \"separateDeliveryAddress\",\n \"optional\" : true,\n \"type\" : \"boolean\",\n \"value\" : \"false\"\n }, {\n \"details\" : [ {\n \"key\" : \"street\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"houseNumberOrName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"city\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"postalCode\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"stateOrProvince\",\n \"optional\" : true,\n \"type\" : \"text\"\n }, {\n \"items\" : [ {\n \"id\" : \"NL\",\n \"name\" : \"Netherlands\"\n }, {\n \"id\" : \"BE\",\n \"name\" : \"Belgium\"\n } ],\n \"key\" : \"country\",\n \"type\" : \"select\",\n \"value\" : \"NL\"\n } ],\n \"key\" : \"deliveryAddress\",\n \"optional\" : true,\n \"type\" : \"address\"\n } ],\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"details\" : [ {\n \"key\" : \"sepa.ownerName\",\n \"type\" : \"text\"\n }, {\n \"key\" : \"sepa.ibanNumber\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.androidpay.token\",\n \"type\" : \"androidPayToken\"\n } ],\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.applepay.token\",\n \"type\" : \"applePayToken\"\n } ],\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.amazonPayToken\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.paywithgoogle.token\",\n \"type\" : \"payWithGoogleToken\"\n } ],\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"details\" : [ {\n \"key\" : \"additionalData.visacheckout.callId\",\n \"type\" : \"text\"\n } ],\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ],\n \"storedPaymentMethods\" : [ {\n \"brand\" : \"visa\",\n \"expiryMonth\" : \"10\",\n \"expiryYear\" : \"30\",\n \"holderName\" : \"John Smith\",\n \"id\" : \"7219687191761347\",\n \"issuerName\" : \"ISSUER_NAME\",\n \"lastFour\" : \"1111\",\n \"name\" : \"VISA\",\n \"shopperEmail\" : \"john.smith@example.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"supportedRecurringProcessingModels\" : [ \"CardOnFile\", \"Subscription\", \"UnscheduledCardOnFile\" ],\n \"type\" : \"scheme\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,790 +2692,1220 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044925\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"065696\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"082338\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"storePaymentMethod\" : true,\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"003704\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"storePaymentMethod\" : true,\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"storePaymentMethod\" : true,\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"googlepay\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"googlepay\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"action\" : {\n \"paymentMethodType\" : \"ideal\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\",\n \"method\" : \"GET\",\n \"type\" : \"redirect\"\n },\n \"paymentData\" : \"Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 40000\n },\n \"donationToken\" : \"81234567890123456...\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"098871\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2212,106 +3913,167 @@ { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"Authorised\",\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Submit 3D Secure 2 authentication result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] } - ] }, { @@ -2324,55 +4086,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2380,49 +4200,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2430,55 +4251,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v68.json b/postman/CheckoutService-v68.json index 91a9ca7..c33ec50 100644 --- a/postman/CheckoutService-v68.json +++ b/postman/CheckoutService-v68.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 300\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ],\n \"storedPaymentMethods\" : [ {\n \"brand\" : \"visa\",\n \"expiryMonth\" : \"10\",\n \"expiryYear\" : \"30\",\n \"holderName\" : \"John Smith\",\n \"id\" : \"7219687191761347\",\n \"issuerName\" : \"ISSUER_NAME\",\n \"lastFour\" : \"1111\",\n \"name\" : \"VISA\",\n \"shopperEmail\" : \"john.smith@example.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"supportedRecurringProcessingModels\" : [ \"CardOnFile\", \"Subscription\", \"UnscheduledCardOnFile\" ],\n \"type\" : \"scheme\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,790 +2692,1220 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"additionalData\" : {\n \"allow3DS2\" : \"true\"\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044925\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"065696\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"082338\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"storePaymentMethod\" : true,\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"003704\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"storePaymentMethod\" : true,\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"storePaymentMethod\" : true,\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"googlepay\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"googlepay\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"action\" : {\n \"paymentMethodType\" : \"ideal\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\",\n \"method\" : \"GET\",\n \"type\" : \"redirect\"\n },\n \"paymentData\" : \"Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"authCode\" : \"008304\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardHolderName\" : \"John Smith\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"avsResultRaw\" : \"5\",\n \"cvcResultRaw\" : \"M\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"993617895204576J\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"paymentMethod\" : {\n \"brand\" : \"visa\",\n \"type\" : \"scheme\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"098871\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\"\n },\n \"pspReference\" : \"YOUR_PSP_REFERENCE\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"YOUR_MERCHANT_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2212,106 +3913,167 @@ { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"Authorised\",\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Submit 3D Secure 2 authentication result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -2319,202 +4081,437 @@ { "name": "Create a payment session", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2022-01-11T13:53:18+01:00\",\n \"id\" : \"CS451F2AB1ED897A94\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Create a payment session including Klarna fields", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"countryCode\" : \"SE\",\n \"dateOfBirth\" : \"1996-09-04T02:00:00+02:00\",\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"expiresAt\" : \"2022-01-11T13:57:52+01:00\",\n \"id\" : \"CSC52E9932D39ADAF3\",\n \"lineItems\" : [ {\n \"amountExcludingTax\" : 331,\n \"amountIncludingTax\" : 400,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\",\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"quantity\" : 1,\n \"taxAmount\" : 69,\n \"taxPercentage\" : 2100\n }, {\n \"amountExcludingTax\" : 248,\n \"amountIncludingTax\" : 300,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\",\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"quantity\" : 2,\n \"taxAmount\" : 52,\n \"taxPercentage\" : 2100\n } ],\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"returnUrl\" : \"https://example.org\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperLocale\" : \"en_US\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"socialSecurityNumber\" : \"0108\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2022-01-11T13:56:05+01:00\",\n \"id\" : \"CSEE37DC1DD751A01F\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"storePaymentMethod\" : true,\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"expiresAt\" : \"2023-06-26T11:01:55+02:00\",\n \"id\" : \"CSFCBC80570618EF2C\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"shopperLocale\" : \"en-US\",\n \"splits\" : [ {\n \"account\" : \"BA00000000000000000000001\",\n \"amount\" : {\n \"value\" : 39200\n },\n \"description\" : \"Your description for the sale amount\",\n \"reference\" : \"Your reference for the sale amount\",\n \"type\" : \"BalanceAccount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"description\" : \"Your description for the commission\",\n \"reference\" : \"Your reference for the commission\",\n \"type\" : \"Commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"description\" : \"Your description for the fees\",\n \"reference\" : \"Your reference for the fees\",\n \"type\" : \"PaymentFee\"\n } ],\n \"sessionData\" : \"Ab02b4c0!BQABAgCjTErwAztqXSFTiZtxZMjRLYkoGbPkmvCvDX1\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "name": "/sessions/:sessionId", "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.", @@ -2522,55 +4519,56 @@ { "name": "Get the result of a payment session", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions/:sessionId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions", - ":sessionId" - ], - "variable": [ - { - "key": "sessionId", - "value": "", - "description": "A unique identifier of the session." - } - ], - "query": [ - { - "key": "sessionResult", - "value": "sessionResult_example", - "description": "The `sessionResult` value from the Drop-in or Component.", - "disabled": false - } - ] - }, - "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId", + "value": "", + "description": "A unique identifier of the session." + } + ], + "query": [ + { + "key": "sessionResult", + "value": "sessionResult_example", + "description": "The `sessionResult` value from the Drop-in or Component.", + "disabled": false + } + ] + }, + "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path." +} + ,"response": [ + ] } ] } - ] }, { @@ -2583,55 +4581,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2639,49 +4695,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2689,55 +4746,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v69.json b/postman/CheckoutService-v69.json index 5b78d40..811137c 100644 --- a/postman/CheckoutService-v69.json +++ b/postman/CheckoutService-v69.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 300\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,104 +1970,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1162,104 +2140,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1267,153 +2362,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ],\n \"storedPaymentMethods\" : [ {\n \"brand\" : \"visa\",\n \"expiryMonth\" : \"10\",\n \"expiryYear\" : \"30\",\n \"holderName\" : \"John Smith\",\n \"id\" : \"7219687191761347\",\n \"issuerName\" : \"ISSUER_NAME\",\n \"lastFour\" : \"1111\",\n \"name\" : \"VISA\",\n \"shopperEmail\" : \"john.smith@example.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"supportedRecurringProcessingModels\" : [ \"CardOnFile\", \"Subscription\", \"UnscheduledCardOnFile\" ],\n \"type\" : \"scheme\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1421,790 +2692,1220 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"authenticationData\" : {\n \"threeDSRequestData\" : {\n \"nativeThreeDS\" : \"preferred\"\n }\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"authenticationData\" : {\n \"threeDSRequestData\" : {\n \"nativeThreeDS\" : \"preferred\"\n }\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044925\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VEP3H\"\n },\n \"pspReference\" : \"993617895204576J\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"065696\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VIE9N\"\n },\n \"pspReference\" : \"993617895215577D\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"082338\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VC172\"\n },\n \"pspReference\" : \"993617895195570C\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"storePaymentMethod\" : true,\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"003704\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VCKO0\"\n },\n \"pspReference\" : \"993617895197573E\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"storePaymentMethod\" : true,\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"storePaymentMethod\" : true,\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"action\" : {\n \"paymentMethodType\" : \"ideal\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\",\n \"method\" : \"GET\",\n \"type\" : \"redirect\"\n },\n \"paymentData\" : \"Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV, using encrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"donationToken\" : \"81234567890123456...\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"paymentMethod\" : {\n \"brand\" : \"visa\",\n \"type\" : \"scheme\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"098871\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VD896\"\n },\n \"pspReference\" : \"993617895199574A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2212,106 +3913,167 @@ { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"Authorised\",\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Submit 3D Secure 2 authentication result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -2319,202 +4081,437 @@ { "name": "Create a payment session", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2022-01-11T13:53:18+01:00\",\n \"id\" : \"CS451F2AB1ED897A94\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Create a payment session including Klarna fields", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"countryCode\" : \"SE\",\n \"dateOfBirth\" : \"1996-09-04T02:00:00+02:00\",\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"expiresAt\" : \"2022-01-11T13:57:52+01:00\",\n \"id\" : \"CSC52E9932D39ADAF3\",\n \"lineItems\" : [ {\n \"amountExcludingTax\" : 331,\n \"amountIncludingTax\" : 400,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\",\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"quantity\" : 1,\n \"taxAmount\" : 69,\n \"taxPercentage\" : 2100\n }, {\n \"amountExcludingTax\" : 248,\n \"amountIncludingTax\" : 300,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\",\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"quantity\" : 2,\n \"taxAmount\" : 52,\n \"taxPercentage\" : 2100\n } ],\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"returnUrl\" : \"https://example.org\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperLocale\" : \"en_US\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"socialSecurityNumber\" : \"0108\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2022-01-11T13:56:05+01:00\",\n \"id\" : \"CSEE37DC1DD751A01F\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"storePaymentMethod\" : true,\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"expiresAt\" : \"2023-06-26T11:01:55+02:00\",\n \"id\" : \"CSFCBC80570618EF2C\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"shopperLocale\" : \"en-US\",\n \"splits\" : [ {\n \"account\" : \"BA00000000000000000000001\",\n \"amount\" : {\n \"value\" : 39200\n },\n \"description\" : \"Your description for the sale amount\",\n \"reference\" : \"Your reference for the sale amount\",\n \"type\" : \"BalanceAccount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"description\" : \"Your description for the commission\",\n \"reference\" : \"Your reference for the commission\",\n \"type\" : \"Commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"description\" : \"Your description for the fees\",\n \"reference\" : \"Your reference for the fees\",\n \"type\" : \"PaymentFee\"\n } ],\n \"sessionData\" : \"Ab02b4c0!BQABAgCjTErwAztqXSFTiZtxZMjRLYkoGbPkmvCvDX1\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "name": "/sessions/:sessionId", "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.", @@ -2522,55 +4519,56 @@ { "name": "Get the result of a payment session", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions/:sessionId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions", - ":sessionId" - ], - "variable": [ - { - "key": "sessionId", - "value": "", - "description": "A unique identifier of the session." - } - ], - "query": [ - { - "key": "sessionResult", - "value": "sessionResult_example", - "description": "The `sessionResult` value from the Drop-in or Component.", - "disabled": false - } - ] - }, - "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId", + "value": "", + "description": "A unique identifier of the session." + } + ], + "query": [ + { + "key": "sessionResult", + "value": "sessionResult_example", + "description": "The `sessionResult` value from the Drop-in or Component.", + "disabled": false + } + ] + }, + "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path." +} + ,"response": [ + ] } ] } - ] }, { @@ -2583,55 +4581,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2639,49 +4695,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2689,55 +4746,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v70.json b/postman/CheckoutService-v70.json index 8bc84c0..fb56faa 100644 --- a/postman/CheckoutService-v70.json +++ b/postman/CheckoutService-v70.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 300\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,55 +1970,56 @@ { "name": "Get tokens for stored payment details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storedPaymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storedPaymentMethods" - ], - "variable": [ - ], - "query": [ - { - "key": "shopperReference", - "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", - "description": "Your merchant account.", - "disabled": true - } - ] - }, - "description": "Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper's payment. A summary of the stored details is included. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storedPaymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storedPaymentMethods" + ], + "variable": [ + ], + "query": [ + { + "key": "shopperReference", + "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", + "description": "Your merchant account.", + "disabled": true + } + ] + }, + "description": "Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper's payment. A summary of the stored details is included. " +} + ,"response": [ + ] } ] - } -, + }, { "name": "/storedPaymentMethods/:storedPaymentMethodId", "description": "Deletes the token identified in the path. The token can no longer be used with payment requests.", @@ -1108,55 +2027,56 @@ { "name": "Delete a token for stored payment details", "request": { - "method": "DELETE", - "header": [ - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storedPaymentMethods/:storedPaymentMethodId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storedPaymentMethods", - ":storedPaymentMethodId" - ], - "variable": [ - { - "key": "storedPaymentMethodId", - "value": "", - "description": "The unique identifier of the token." - } - ], - "query": [ - { - "key": "shopperReference", - "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", - "description": "Your merchant account.", - "disabled": false - } - ] - }, - "description": "Deletes the token identified in the path. The token can no longer be used with payment requests." - } + "method": "DELETE", + "header": [ + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storedPaymentMethods/:storedPaymentMethodId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storedPaymentMethods", + ":storedPaymentMethodId" + ], + "variable": [ + { + "key": "storedPaymentMethodId", + "value": "", + "description": "The unique identifier of the token." + } + ], + "query": [ + { + "key": "shopperReference", + "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", + "description": "Your merchant account.", + "disabled": false + } + ] + }, + "description": "Deletes the token identified in the path. The token can no longer be used with payment requests." +} + ,"response": [ + ] } ] } - ] }, { @@ -1169,104 +2089,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1279,104 +2259,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1384,153 +2481,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"Credit Card\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"supportsRecurring\" : true,\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ],\n \"storedPaymentMethods\" : [ {\n \"brand\" : \"visa\",\n \"expiryMonth\" : \"10\",\n \"expiryYear\" : \"30\",\n \"holderName\" : \"John Smith\",\n \"id\" : \"7219687191761347\",\n \"issuerName\" : \"ISSUER_NAME\",\n \"lastFour\" : \"1111\",\n \"name\" : \"VISA\",\n \"shopperEmail\" : \"john.smith@example.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"supportedRecurringProcessingModels\" : [ \"CardOnFile\", \"Subscription\", \"UnscheduledCardOnFile\" ],\n \"type\" : \"scheme\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1538,692 +2811,1061 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"authenticationData\" : {\n \"threeDSRequestData\" : {\n \"nativeThreeDS\" : \"preferred\"\n }\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"authenticationData\" : {\n \"threeDSRequestData\" : {\n \"nativeThreeDS\" : \"preferred\"\n }\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with unencrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044925\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VEP3H\"\n },\n \"pspReference\" : \"993617895204576J\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"065696\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VIE9N\"\n },\n \"pspReference\" : \"993617895215577D\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"082338\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VC172\"\n },\n \"pspReference\" : \"993617895195570C\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"action\" : {\n \"paymentMethodType\" : \"ideal\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\",\n \"method\" : \"GET\",\n \"type\" : \"redirect\"\n },\n \"paymentData\" : \"Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a subscription card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"donationToken\" : \"81234567890123456...\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"paymentMethod\" : {\n \"brand\" : \"visa\",\n \"type\" : \"scheme\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"098871\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VD896\"\n },\n \"pspReference\" : \"993617895199574A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2231,106 +3873,167 @@ { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"Authorised\",\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Submit 3D Secure 2 authentication result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -2338,202 +4041,437 @@ { "name": "Create a payment session", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2022-01-11T13:53:18+01:00\",\n \"id\" : \"CS451F2AB1ED897A94\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Create a payment session including Klarna fields", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"countryCode\" : \"SE\",\n \"dateOfBirth\" : \"1996-09-04T02:00:00+02:00\",\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"expiresAt\" : \"2022-01-11T13:57:52+01:00\",\n \"id\" : \"CSC52E9932D39ADAF3\",\n \"lineItems\" : [ {\n \"amountExcludingTax\" : 331,\n \"amountIncludingTax\" : 400,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\",\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"quantity\" : 1,\n \"taxAmount\" : 69,\n \"taxPercentage\" : 2100\n }, {\n \"amountExcludingTax\" : 248,\n \"amountIncludingTax\" : 300,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\",\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"quantity\" : 2,\n \"taxAmount\" : 52,\n \"taxPercentage\" : 2100\n } ],\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"returnUrl\" : \"https://example.org\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperLocale\" : \"en_US\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"socialSecurityNumber\" : \"0108\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Tokenize card details for one-off payments without asking shopper", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethodMode\" : \"enabled\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2022-01-11T13:56:05+01:00\",\n \"id\" : \"FJM726V375BV9D82\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"storePaymentMethod\" : true,\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethodMode\" : \"enabled\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethodMode\" : \"enabled\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"expiresAt\" : \"2023-06-26T11:01:55+02:00\",\n \"id\" : \"CSFCBC80570618EF2C\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"shopperLocale\" : \"en-US\",\n \"splits\" : [ {\n \"account\" : \"BA00000000000000000000001\",\n \"amount\" : {\n \"value\" : 39200\n },\n \"description\" : \"Your description for the sale amount\",\n \"reference\" : \"Your reference for the sale amount\",\n \"type\" : \"BalanceAccount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"description\" : \"Your description for the commission\",\n \"reference\" : \"Your reference for the commission\",\n \"type\" : \"Commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"description\" : \"Your description for the fees\",\n \"reference\" : \"Your reference for the fees\",\n \"type\" : \"PaymentFee\"\n } ],\n \"mode\" : \"embedded\",\n \"sessionData\" : \"Ab02b4c0!BQABAgCjTErwAztqXSFTiZtxZMjRLYkoGbPkmvCvDX1\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "name": "/sessions/:sessionId", "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.", @@ -2541,55 +4479,56 @@ { "name": "Get the result of a payment session", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions/:sessionId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions", - ":sessionId" - ], - "variable": [ - { - "key": "sessionId", - "value": "", - "description": "A unique identifier of the session." - } - ], - "query": [ - { - "key": "sessionResult", - "value": "sessionResult_example", - "description": "The `sessionResult` value from the Drop-in or Component.", - "disabled": false - } - ] - }, - "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId", + "value": "", + "description": "A unique identifier of the session." + } + ], + "query": [ + { + "key": "sessionResult", + "value": "sessionResult_example", + "description": "The `sessionResult` value from the Drop-in or Component.", + "disabled": false + } + ] + }, + "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path." +} + ,"response": [ + ] } ] } - ] }, { @@ -2602,55 +4541,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2658,49 +4655,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2708,55 +4706,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/CheckoutService-v71.json b/postman/CheckoutService-v71.json index ee7ca10..b076e36 100644 --- a/postman/CheckoutService-v71.json +++ b/postman/CheckoutService-v71.json @@ -19,55 +19,113 @@ { "name": "Cancel a payment using your own reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cancels" + ], + "variable": [ + ], + "query": [ + ] + }, + "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cancels" - ], - "variable": [ - ], - "query": [ - ] - }, - "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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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)." - } + ] } ] - } -, + }, { "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).", @@ -75,62 +133,127 @@ { "name": "Update the amount of an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "amountUpdates" + ], + "variable": [ + { + "key": "paymentPspReference", + "value": "", + "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "amountUpdates" - ], - "variable": [ - { - "key": "paymentPspReference", - "value": "", - "description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -138,62 +261,127 @@ { "name": "Cancel payment using a PSP reference", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "cancels" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/cancels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "cancels" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -201,62 +389,127 @@ { "name": "Capture an authorised payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "captures" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/captures", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "captures" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -264,62 +517,127 @@ { "name": "Refund a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "refunds" + ], + "variable": [ + { + "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." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/refunds", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "refunds" - ], - "variable": [ - { - "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." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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).", @@ -327,62 +645,127 @@ { "name": "Reverse (cancel or refund) a payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\" : \"993617894903480A\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\" : \"993617894906488A\",\n \"status\" : \"received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + ":paymentPspReference", + "reversals" + ], + "variable": [ + { + "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. " + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/:paymentPspReference/reversals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - ":paymentPspReference", - "reversals" - ], - "variable": [ - { - "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. " - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -395,251 +778,374 @@ { "name": "Set up a payment session (Android)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session with the option to store card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"enableOneClick\" : true,\n \"enableRecurring\" : true,\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.7.0\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] }, { "name": "Set up a payment session (iOS)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"iOS\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Split a payment between a sub-merchant and a platform account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 6200\n },\n \"additionalData\" : {\n \"split.api\" : \"1\",\n \"split.nrOfItems\" : \"2\",\n \"split.totalAmount\" : \"6200\",\n \"split.currencyCode\" : \"EUR\",\n \"split.item1.amount\" : \"6000\",\n \"split.item1.type\" : \"MarketPlace\",\n \"split.item1.account\" : \"151272963\",\n \"split.item1.reference\" : \"6124145\",\n \"split.item1.description\" : \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\" : \"200\",\n \"split.item2.type\" : \"Commission\",\n \"split.item2.reference\" : \"6124146\"\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Android\",\n \"token\" : \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\" : \"app://\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"sessionValidity\" : \"2017-04-06T13:09:13Z\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + ] }, { "name": "Set up a payment session (Web)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentSession\" : \"eyJjaGVja291dHNob3BwZXJCYXN...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 17408\n },\n \"reference\" : \"Your order number\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"channel\" : \"Web\",\n \"origin\" : \"https://www.yourwebsite.com\",\n \"returnUrl\" : \"https://www.yourshop.com/checkout/result\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl_NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\" : \"1.9.5\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentSession", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentSession" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." - } + ] } ] - } -, + }, { "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).", @@ -647,56 +1153,115 @@ { "name": "Verify payment results", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\",\n \"merchantReference\" : \"Your order number\",\n \"shopperLocale\" : \"nl_NL\",\n \"paymentMethod\" : \"ideal\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\" : \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/result", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "result" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] }, { @@ -709,55 +1274,113 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8616178914061985\",\n \"resultCode\" : \"Success\",\n \"expiresAt\" : \"2021-04-09T14:16:46Z\",\n \"orderData\" : \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"remainingAmount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 300\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"EUR\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods." - } + ] } ] - } -, + }, { "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.", @@ -765,56 +1388,115 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"8816178914079738\",\n \"resultCode\" : \"Received\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/orders/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "orders", + "cancel" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"order\" : {\n \"pspReference\" : \"8815517812932012\",\n \"orderData\" : \"823fh892f8f18f4...148f13f9f3f\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/orders/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "orders", - "cancel" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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.", @@ -822,106 +1504,225 @@ { "name": "Get gift card balance specifying amount of 10 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"KHQC5N7G84BLNK43\",\n \"resultCode\" : \"Success\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get gift card balance specifying amount of 100 EUR", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"FKSPNCQ8HXSKGK82\",\n \"resultCode\" : \"NotEnoughBalance\",\n \"balance\" : {\n \"currency\" : \"EUR\",\n \"value\" : 5000\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods/balance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods", + "balance" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"givex\",\n \"number\" : \"4126491073027401\",\n \"cvc\" : \"737\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods/balance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods", - "balance" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] } - ] }, { @@ -934,56 +1735,115 @@ { "name": "Get payment session for Apple Pay", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"eyJ2Z...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/applePay/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "applePay", + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"displayName\" : \"YOUR_MERCHANT_NAME\",\n \"domainName\" : \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\" : \"YOUR_MERCHANT_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/applePay/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applePay", - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)." - } + ] } ] - } -, + }, { "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. ", @@ -991,55 +1851,113 @@ { "name": "Get origin keys", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"originKeys\" : {\n \"https://www.your-domain1.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\" : \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/originKeys", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "originKeys" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"originDomains\" : [ \"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/originKeys", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "originKeys" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] } - ] }, { @@ -1052,55 +1970,56 @@ { "name": "Get tokens for stored payment details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storedPaymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storedPaymentMethods" - ], - "variable": [ - ], - "query": [ - { - "key": "shopperReference", - "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", - "description": "Your merchant account.", - "disabled": true - } - ] - }, - "description": "Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper's payment. A summary of the stored details is included. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storedPaymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storedPaymentMethods" + ], + "variable": [ + ], + "query": [ + { + "key": "shopperReference", + "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", + "description": "Your merchant account.", + "disabled": true + } + ] + }, + "description": "Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper's payment. A summary of the stored details is included. " +} + ,"response": [ + ] } ] - } -, + }, { "name": "/storedPaymentMethods/:storedPaymentMethodId", "description": "Deletes the token identified in the path. The token can no longer be used with payment requests.", @@ -1108,55 +2027,56 @@ { "name": "Delete a token for stored payment details", "request": { - "method": "DELETE", - "header": [ - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storedPaymentMethods/:storedPaymentMethodId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storedPaymentMethods", - ":storedPaymentMethodId" - ], - "variable": [ - { - "key": "storedPaymentMethodId", - "value": "", - "description": "The unique identifier of the token." - } - ], - "query": [ - { - "key": "shopperReference", - "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", - "description": "Your merchant account.", - "disabled": false - } - ] - }, - "description": "Deletes the token identified in the path. The token can no longer be used with payment requests." - } + "method": "DELETE", + "header": [ + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storedPaymentMethods/:storedPaymentMethodId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storedPaymentMethods", + ":storedPaymentMethodId" + ], + "variable": [ + { + "key": "storedPaymentMethodId", + "value": "", + "description": "The unique identifier of the token." + } + ], + "query": [ + { + "key": "shopperReference", + "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", + "description": "Your merchant account.", + "disabled": false + } + ] + }, + "description": "Deletes the token identified in the path. The token can no longer be used with payment requests." +} + ,"response": [ + ] } ] } - ] }, { @@ -1169,104 +2089,164 @@ { "name": "Start a donation transaction", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"UNIQUE_RESOURCE_ID\",\n \"status\" : \"completed\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"payment\" : {\n \"pspReference\" : \"8535762347980628\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantReference\" : \"YOUR_DONATION_REFERENCE\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\"\n },\n \"donationToken\" : \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\" : \"991559660454807J\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] }, { "name": "Start a donation transaction with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/donations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "donations" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"recurringDetailReference\" : \"7219687191761347\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\" : \"CHARITY_ACCOUNT\",\n \"shopperInteraction\" : \"ContAuth\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/donations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "donations" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + ] } ] } - ] }, { @@ -1279,104 +2259,221 @@ { "name": "Get a list of brands on a card", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : true\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] }, { "name": "Get a list of brands on a card specifying your supported card brands", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"brands\" : [ {\n \"type\" : \"visa\",\n \"supported\" : true\n }, {\n \"type\" : \"cartebancaire\",\n \"supported\" : false\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/cardDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "cardDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\" : \"411111\",\n \"supportedBrands\" : [ \"visa\", \"mc\", \"amex\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/cardDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "cardDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. " - } + ] } ] - } -, + }, { "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.", @@ -1384,153 +2481,329 @@ { "name": "Get available payment methods", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"ACH Direct Debit\",\n \"type\" : \"ach\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"Afterpay\",\n \"type\" : \"afterpaytouch\"\n }, {\n \"name\" : \"Cards\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay HK\",\n \"type\" : \"alipay_hk\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Credit Card via AsiaPay\",\n \"type\" : \"asiapay\"\n }, {\n \"name\" : \"China UnionPay\",\n \"type\" : \"asiapay_unionpay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"Baloto\",\n \"type\" : \"baloto\"\n }, {\n \"name\" : \"BancNet\",\n \"type\" : \"bancnet\"\n }, {\n \"name\" : \"Bank Transfer (BG)\",\n \"type\" : \"bankTransfer_BG\"\n }, {\n \"name\" : \"Bank Transfer (CH)\",\n \"type\" : \"bankTransfer_CH\"\n }, {\n \"name\" : \"Bank Transfer (DE)\",\n \"type\" : \"bankTransfer_DE\"\n }, {\n \"name\" : \"Bank Transfer (FI)\",\n \"type\" : \"bankTransfer_FI\"\n }, {\n \"name\" : \"Bank Transfer (GB)\",\n \"type\" : \"bankTransfer_GB\"\n }, {\n \"name\" : \"Bank Transfer (HU)\",\n \"type\" : \"bankTransfer_HU\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bank Transfer (IE)\",\n \"type\" : \"bankTransfer_IE\"\n }, {\n \"name\" : \"Electronic Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_linked\"\n }, {\n \"name\" : \"Bank Transfer (MX)\",\n \"type\" : \"bankTransfer_MX_offline\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Bank Transfer (PL)\",\n \"type\" : \"bankTransfer_PL\"\n }, {\n \"name\" : \"Bank Transfer (SE)\",\n \"type\" : \"bankTransfer_SE\"\n }, {\n \"name\" : \"Bank Transfer (US)\",\n \"type\" : \"bankTransfer_US\"\n }, {\n \"name\" : \"Payconiq by Bancontact\",\n \"type\" : \"bcmc_mobile\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"99Bill\",\n \"type\" : \"bill99\"\n }, {\n \"name\" : \"Online Banking India\",\n \"type\" : \"billdesk_online\"\n }, {\n \"name\" : \"UPI\",\n \"type\" : \"billdesk_upi\"\n }, {\n \"name\" : \"Wallets India\",\n \"type\" : \"billdesk_wallet\"\n }, {\n \"name\" : \"Blik\",\n \"type\" : \"blik\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Boleto\",\n \"type\" : \"boleto\"\n }, {\n \"name\" : \"Boleto Bancario\",\n \"type\" : \"boletobancario_santander\"\n }, {\n \"name\" : \"Bradesco\",\n \"type\" : \"bradesco\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"CashU\",\n \"type\" : \"cashu\"\n }, {\n \"name\" : \"CCAvenue\",\n \"type\" : \"ccavenue\"\n }, {\n \"name\" : \"Mula Checkout\",\n \"type\" : \"cellulant\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"Clearpay\",\n \"type\" : \"clearpay\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\" : \"cofinoga_3xcb\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"DANA\",\n \"type\" : \"dana\"\n }, {\n \"name\" : \"DineroMail\",\n \"type\" : \"dineromail\"\n }, {\n \"name\" : \"Online bank transfer.\",\n \"type\" : \"directEbanking\"\n }, {\n \"name\" : \"Direct Debit Brazil - Banco do Brazil\",\n \"type\" : \"directdebit_BR_bancodobrasil\"\n }, {\n \"name\" : \"Direct Debit Brazil - Bradesco\",\n \"type\" : \"directdebit_BR_bradesco\"\n }, {\n \"name\" : \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\" : \"directdebit_BR_caixa\"\n }, {\n \"name\" : \"Direct Debit Brazil - HSBC\",\n \"type\" : \"directdebit_BR_hsbc\"\n }, {\n \"name\" : \"Direct Debit Brazil - Itau\",\n \"type\" : \"directdebit_BR_itau\"\n }, {\n \"name\" : \"Direct Debit Brazil - Santander\",\n \"type\" : \"directdebit_BR_santander\"\n }, {\n \"name\" : \"BACS Direct Debit\",\n \"type\" : \"directdebit_GB\"\n }, {\n \"name\" : \"Alfamart\",\n \"type\" : \"doku_alfamart\"\n }, {\n \"name\" : \"BCA Bank Transfer\",\n \"type\" : \"doku_bca_va\"\n }, {\n \"name\" : \"BNI VA\",\n \"type\" : \"doku_bni_va\"\n }, {\n \"name\" : \"BRI VA\",\n \"type\" : \"doku_bri_va\"\n }, {\n \"name\" : \"CIMB VA\",\n \"type\" : \"doku_cimb_va\"\n }, {\n \"name\" : \"Danamon VA\",\n \"type\" : \"doku_danamon_va\"\n }, {\n \"name\" : \"Indomaret\",\n \"type\" : \"doku_indomaret\"\n }, {\n \"name\" : \"Mandiri VA\",\n \"type\" : \"doku_mandiri_va\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"doku_ovo\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"doku_permata_lite_atm\"\n }, {\n \"name\" : \"DOKU wallet\",\n \"type\" : \"doku_wallet\"\n }, {\n \"name\" : \"Local Polish Payment Methods\",\n \"type\" : \"dotpay\"\n }, {\n \"name\" : \"Dragonpay Prepaid Credits\",\n \"type\" : \"dragonpay_credits\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"dragonpay_ebanking\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"dragonpay_gcash\"\n }, {\n \"name\" : \"Over The Counter Banks\",\n \"type\" : \"dragonpay_otc_banking\"\n }, {\n \"name\" : \"OTC non-Bank via Dragonpay\",\n \"type\" : \"dragonpay_otc_non_banking\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"dragonpay_otc_philippines\"\n }, {\n \"name\" : \"7/11\",\n \"type\" : \"dragonpay_seveneleven\"\n }, {\n \"name\" : \"eagleeye_voucher\",\n \"type\" : \"eagleeye_voucher\"\n }, {\n \"name\" : \"Finnish E-Banking\",\n \"type\" : \"ebanking_FI\"\n }, {\n \"name\" : \"Pay-easy ATM\",\n \"type\" : \"econtext_atm\"\n }, {\n \"name\" : \"Online Banking\",\n \"type\" : \"econtext_online\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"econtext_seven_eleven\"\n }, {\n \"name\" : \"Convenience Stores\",\n \"type\" : \"econtext_stores\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Lastschrift (ELV)\",\n \"type\" : \"elv\"\n }, {\n \"name\" : \"Bank Payment\",\n \"type\" : \"entercash\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"EPS\",\n \"type\" : \"eps\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"3x Oney\",\n \"type\" : \"facilypay_3x\"\n }, {\n \"name\" : \"4x Oney\",\n \"type\" : \"facilypay_4x\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"Fawry\",\n \"type\" : \"fawry\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"GCash\",\n \"type\" : \"gcash\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Globe GCash\",\n \"type\" : \"globegcash\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"GoPay Wallet\",\n \"type\" : \"gopay_wallet\"\n }, {\n \"name\" : \"OVO\",\n \"type\" : \"grabpay_ID\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_PH\"\n }, {\n \"name\" : \"GrabPay\",\n \"type\" : \"grabpay_SG\"\n }, {\n \"name\" : \"Hallmark Card\",\n \"type\" : \"hallmarkcard\"\n }, {\n \"name\" : \"HDFC\",\n \"type\" : \"hdfc\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"igive\",\n \"type\" : \"igive\"\n }, {\n \"name\" : \"Korean Account Transfer (IniPay)\",\n \"type\" : \"inicisIniPay_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (IniPay)\",\n \"type\" : \"inicisIniPay_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (IniPay)\",\n \"type\" : \"inicisIniPay_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (IniPay)\",\n \"type\" : \"inicisIniPay_virtualaccount\"\n }, {\n \"name\" : \"Korean Account Transfer (Mobile)\",\n \"type\" : \"inicisMobile_accounttransfer\"\n }, {\n \"name\" : \"Korean Credit Cards (Mobile)\",\n \"type\" : \"inicisMobile_creditcard\"\n }, {\n \"name\" : \"Korean Mobile Phone (Mobile)\",\n \"type\" : \"inicisMobile_mobilephone\"\n }, {\n \"name\" : \"Korean Virtual Account (Mobile)\",\n \"type\" : \"inicisMobile_virtualaccount\"\n }, {\n \"name\" : \"Korean Credit Cards\",\n \"type\" : \"inicis_creditcard\"\n }, {\n \"name\" : \"Interac® Online\",\n \"type\" : \"interac\"\n }, {\n \"name\" : \"Instant EFT\",\n \"type\" : \"ipay\"\n }, {\n \"name\" : \"iPay88\",\n \"type\" : \"ipay88\"\n }, {\n \"name\" : \"isracard\",\n \"type\" : \"isracard\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"KakaoPay\",\n \"type\" : \"kakaopay\"\n }, {\n \"name\" : \"Karen Millen Card\",\n \"type\" : \"karenmillen\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Bank Transfer\",\n \"type\" : \"kcp_banktransfer\"\n }, {\n \"name\" : \"Korea–issued cards\",\n \"type\" : \"kcp_creditcard\"\n }, {\n \"name\" : \"PayCo\",\n \"type\" : \"kcp_payco\"\n }, {\n \"name\" : \"Naver Pay\",\n \"type\" : \"kcp_naverpay\"\n }, {\n \"name\" : \"Virtual Account via KCP\",\n \"type\" : \"kcp_va\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"Pay over time with Klarna.\",\n \"type\" : \"klarna_account\"\n }, {\n \"name\" : \"Buy Now, Pay Later with Billie\",\n \"type\" : \"klarna_b2b\"\n }, {\n \"name\" : \"Pay now with Klarna.\",\n \"type\" : \"klarna_paynow\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"China Credit Card\",\n \"type\" : \"lianlianpay_creditcard\"\n }, {\n \"name\" : \"China Debit Card\",\n \"type\" : \"lianlianpay_debitcard\"\n }, {\n \"name\" : \"China Online Banking - Credit Card\",\n \"type\" : \"lianlianpay_ebanking_credit\"\n }, {\n \"name\" : \"China Online Banking - Debit Card\",\n \"type\" : \"lianlianpay_ebanking_debit\"\n }, {\n \"name\" : \"China Online Banking - Enterprise\",\n \"type\" : \"lianlianpay_ebanking_enterprise\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Love2Shop GiftCard\",\n \"type\" : \"love2shop\"\n }, {\n \"name\" : \"mada\",\n \"type\" : \"mada\"\n }, {\n \"name\" : \"Mappin & Webb Card\",\n \"type\" : \"mappinwebbcard\"\n }, {\n \"name\" : \"MB WAY\",\n \"type\" : \"mbway\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"Mercado Pago\",\n \"type\" : \"mercadopago\"\n }, {\n \"name\" : \"MobilePay\",\n \"type\" : \"mobilepay\"\n }, {\n \"name\" : \"AliPay via Razer Merchant Services\",\n \"type\" : \"molpay_alipay\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"molpay_cash\"\n }, {\n \"name\" : \"CIMB Virtual Account\",\n \"type\" : \"molpay_cimb_va\"\n }, {\n \"name\" : \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\" : \"molpay_ebanking_MY\"\n }, {\n \"name\" : \"Vietnam E-Banking\",\n \"type\" : \"molpay_ebanking_VN\"\n }, {\n \"name\" : \"Malaysia E-Banking\",\n \"type\" : \"molpay_ebanking_fpx_MY\"\n }, {\n \"name\" : \"eNETS Debit\",\n \"type\" : \"molpay_enetsd\"\n }, {\n \"name\" : \"epay\",\n \"type\" : \"molpay_epay\"\n }, {\n \"name\" : \"Esapay\",\n \"type\" : \"molpay_esapay\"\n }, {\n \"name\" : \"MyClear FPX\",\n \"type\" : \"molpay_fpx\"\n }, {\n \"name\" : \"Maybank2u\",\n \"type\" : \"molpay_maybank2u\"\n }, {\n \"name\" : \"Nganluong\",\n \"type\" : \"molpay_nganluong\"\n }, {\n \"name\" : \"Convenience Stores Thailand\",\n \"type\" : \"molpay_paysbuy\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"RHB Now\",\n \"type\" : \"molpay_rhb\"\n }, {\n \"name\" : \"SAM by SingPost\",\n \"type\" : \"molpay_singpost\"\n }, {\n \"name\" : \"MOLWallet\",\n \"type\" : \"molpay_wallet\"\n }, {\n \"name\" : \"MoMo ATM\",\n \"type\" : \"momo_atm\"\n }, {\n \"name\" : \"Momo Wallet\",\n \"type\" : \"momo_wallet\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"Multibanco\",\n \"type\" : \"multibanco\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"BankAxess\",\n \"type\" : \"netaxept_bankaxess\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"One Two Three\",\n \"type\" : \"onetwothree\"\n }, {\n \"name\" : \"Online Banking PL\",\n \"type\" : \"onlineBanking_PL\"\n }, {\n \"name\" : \"Online banking\",\n \"type\" : \"openbanking_UK\"\n }, {\n \"name\" : \"Oxxo\",\n \"type\" : \"oxxo\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"PayBright\",\n \"type\" : \"paybright\"\n }, {\n \"name\" : \"Maya Wallet\",\n \"type\" : \"paymaya_wallet\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Payshop\",\n \"type\" : \"payshop\"\n }, {\n \"name\" : \"PayD AMT via Paythru\",\n \"type\" : \"paythru_amt\"\n }, {\n \"name\" : \"EFT via Paythru\",\n \"type\" : \"paythru_eft\"\n }, {\n \"name\" : \"PayTM\",\n \"type\" : \"paytm\"\n }, {\n \"name\" : \"PayU UPI\",\n \"type\" : \"payu_IN_upi\"\n }, {\n \"name\" : \"EFT Pro via PayU\",\n \"type\" : \"payu_ZA_eftpro\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"pix\",\n \"type\" : \"pix\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"POLi\",\n \"type\" : \"poli\"\n }, {\n \"name\" : \"PPS\",\n \"type\" : \"pps\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"PSE\",\n \"type\" : \"pse\"\n }, {\n \"name\" : \"Qiwi Wallet\",\n \"type\" : \"qiwiwallet\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"SafetyPay\",\n \"type\" : \"safetypay\"\n }, {\n \"name\" : \"SafetyPay Cash\",\n \"type\" : \"safetypay_cash\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"SEB Direktbetalning\",\n \"type\" : \"sebdirectpayment\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"7-Eleven\",\n \"type\" : \"seveneleven\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"Swish\",\n \"type\" : \"swish\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"TenPay\",\n \"type\" : \"tenpay\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"TrueMoney\",\n \"type\" : \"truemoney\"\n }, {\n \"name\" : \"Trustly\",\n \"type\" : \"trustly\"\n }, {\n \"name\" : \"Online Banking by Trustpay\",\n \"type\" : \"trustpay\"\n }, {\n \"name\" : \"TWINT\",\n \"type\" : \"twint\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"UPI Collect\",\n \"type\" : \"upi_collect\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Vipps\",\n \"type\" : \"vipps\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayMiniProgram\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayQR\"\n }, {\n \"name\" : \"WeChat Pay\",\n \"type\" : \"wechatpayWeb\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"WOS Card\",\n \"type\" : \"woscard\"\n }, {\n \"name\" : \"Alfa-Click\",\n \"type\" : \"yandex_alfaclick\"\n }, {\n \"name\" : \"Pay using bank card\",\n \"type\" : \"yandex_bank_card\"\n }, {\n \"name\" : \"Cash terminals\",\n \"type\" : \"yandex_cash\"\n }, {\n \"name\" : \"Pay using installments\",\n \"type\" : \"yandex_installments\"\n }, {\n \"name\" : \"YooMoney\",\n \"type\" : \"yandex_money\"\n }, {\n \"name\" : \"Promsvyazbank\",\n \"type\" : \"yandex_promsvyazbank\"\n }, {\n \"name\" : \"SberPay\",\n \"type\" : \"yandex_sberbank\"\n }, {\n \"name\" : \"WebMoney\",\n \"type\" : \"yandex_webmoney\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n }, {\n \"name\" : \"Zip\",\n \"type\" : \"zip\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods based on the country and amount", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"Hitelkártya\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"shopperLocale\" : \"nl-NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Get payment methods including stored card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"paymentMethods\" : [ {\n \"name\" : \"iDEAL\",\n \"type\" : \"ideal\"\n }, {\n \"name\" : \"Cards\",\n \"type\" : \"scheme\"\n }, {\n \"name\" : \"PayPal\",\n \"type\" : \"paypal\"\n }, {\n \"name\" : \"AfterPay Invoice\",\n \"type\" : \"afterpay_default\"\n }, {\n \"name\" : \"Pay later with Klarna.\",\n \"type\" : \"klarna\"\n }, {\n \"name\" : \"SEPA Direct Debit\",\n \"type\" : \"sepadirectdebit\"\n }, {\n \"name\" : \"Paysafecard\",\n \"type\" : \"paysafecard\"\n }, {\n \"name\" : \"Bijenkorf Cadeaucard\",\n \"type\" : \"bijcadeaucard\"\n }, {\n \"name\" : \"Fonq Giftcard\",\n \"type\" : \"fonqgiftcard\"\n }, {\n \"name\" : \"Bank Transfer (NL)\",\n \"type\" : \"bankTransfer_NL\"\n }, {\n \"name\" : \"Pathe Giftcard\",\n \"type\" : \"pathegiftcard\"\n }, {\n \"name\" : \"VVV Giftcard\",\n \"type\" : \"vvvgiftcard\"\n }, {\n \"name\" : \"Podium Card\",\n \"type\" : \"podiumcard\"\n }, {\n \"name\" : \"RatePay Direct Debit\",\n \"type\" : \"ratepay_directdebit\"\n }, {\n \"name\" : \"Rituals Giftcard\",\n \"type\" : \"rituals\"\n }, {\n \"name\" : \"Hunkemoller Lingerie Card\",\n \"type\" : \"hmlingerie\"\n }, {\n \"name\" : \"Primera Cadeaukaart\",\n \"type\" : \"primeracadeaucard\"\n }, {\n \"name\" : \"Fashioncheque\",\n \"type\" : \"fashioncheque\"\n }, {\n \"name\" : \"NETELLER\",\n \"type\" : \"neteller\"\n }, {\n \"name\" : \"Adyen Voucher\",\n \"type\" : \"adyen_test_voucher\"\n }, {\n \"name\" : \"AfterPay B2B\",\n \"type\" : \"afterpay_b2b\"\n }, {\n \"name\" : \"AfterPay DirectDebit\",\n \"type\" : \"afterpay_directdebit\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay\"\n }, {\n \"name\" : \"AliPay\",\n \"type\" : \"alipay_wap\"\n }, {\n \"name\" : \"Android Pay\",\n \"type\" : \"androidpay\"\n }, {\n \"name\" : \"Apple Pay\",\n \"type\" : \"applepay\"\n }, {\n \"name\" : \"Baby Gift Card\",\n \"type\" : \"babygiftcard\"\n }, {\n \"name\" : \"SEPA Bank Transfer\",\n \"type\" : \"bankTransfer_IBAN\"\n }, {\n \"name\" : \"Bloemen Giftcard\",\n \"type\" : \"bloemengiftcard\"\n }, {\n \"name\" : \"Boekenbon Giftcard\",\n \"type\" : \"boekenbon\"\n }, {\n \"name\" : \"Cash-Ticket\",\n \"type\" : \"cashticket\"\n }, {\n \"name\" : \"Chasin Giftcard\",\n \"type\" : \"chasingiftcard\"\n }, {\n \"name\" : \"ClickandBuy\",\n \"type\" : \"clickandbuy\"\n }, {\n \"name\" : \"Costes Giftcard\",\n \"type\" : \"costesgiftcard\"\n }, {\n \"name\" : \"custom_settlement\",\n \"type\" : \"custom_settlement\"\n }, {\n \"name\" : \"eft_directdebit_CA\",\n \"type\" : \"eft_directdebit_CA\"\n }, {\n \"name\" : \"Nationale Entertainment Card\",\n \"type\" : \"entertainmentcard\"\n }, {\n \"name\" : \"Expert Cadeaukaart\",\n \"type\" : \"expertgiftcard\"\n }, {\n \"name\" : \"FijnCadeau\",\n \"type\" : \"fijncadeau\"\n }, {\n \"name\" : \"Fleurop Bloemenbon\",\n \"type\" : \"fleuropbloemenbon\"\n }, {\n \"name\" : \"Gall & Gall\",\n \"type\" : \"gallgall\"\n }, {\n \"name\" : \"Generic GiftCard\",\n \"type\" : \"genericgiftcard\"\n }, {\n \"name\" : \"GiftFor2\",\n \"type\" : \"giftfor2card\"\n }, {\n \"name\" : \"Givex\",\n \"type\" : \"givex\"\n }, {\n \"name\" : \"Goldsmiths Card\",\n \"type\" : \"goldsmithscard\"\n }, {\n \"name\" : \"Hunkemoller Member Card\",\n \"type\" : \"hmclub\"\n }, {\n \"name\" : \"Phone Payment\",\n \"type\" : \"ivr\"\n }, {\n \"name\" : \"Landline phone\",\n \"type\" : \"ivrLandline\"\n }, {\n \"name\" : \"Mobile phone\",\n \"type\" : \"ivrMobile\"\n }, {\n \"name\" : \"Kado Wereld\",\n \"type\" : \"kadowereld\"\n }, {\n \"name\" : \"Karen Millen GiftCard\",\n \"type\" : \"karenmillengiftcard\"\n }, {\n \"name\" : \"Leisure Card\",\n \"type\" : \"leisurecard\"\n }, {\n \"name\" : \"Loods5 Cadeaukaart\",\n \"type\" : \"loods5giftcard\"\n }, {\n \"name\" : \"Loods5 Tegoedbon\",\n \"type\" : \"loods5prepaidcard\"\n }, {\n \"name\" : \"Amazon Pay\",\n \"type\" : \"amazonpay\"\n }, {\n \"name\" : \"MOLPoints\",\n \"type\" : \"molpay_points\"\n }, {\n \"name\" : \"Moneybookers\",\n \"type\" : \"moneybookers\"\n }, {\n \"name\" : \"De Nationale Musicalcard\",\n \"type\" : \"musicalcard\"\n }, {\n \"name\" : \"Nationale Bioscoopbon\",\n \"type\" : \"nationalebioscoopbon\"\n }, {\n \"name\" : \"Nationale Tuinbon\",\n \"type\" : \"nationaletuinbon\"\n }, {\n \"name\" : \"Nationale Verwen Cadeaubon\",\n \"type\" : \"nationaleverwencadeaubon\"\n }, {\n \"name\" : \"Onebip\",\n \"type\" : \"onebip\"\n }, {\n \"name\" : \"Google Pay\",\n \"type\" : \"paywithgoogle\"\n }, {\n \"name\" : \"Plastix\",\n \"type\" : \"plastix\"\n }, {\n \"name\" : \"Pluim\",\n \"type\" : \"pluimgiftcard\"\n }, {\n \"name\" : \"Illicado Gift Card\",\n \"type\" : \"prosodie_illicado\"\n }, {\n \"name\" : \"RatePay Invoice\",\n \"type\" : \"ratepay\"\n }, {\n \"name\" : \"Rob Peetoom Giftcard\",\n \"type\" : \"robpeetoomgiftcard\"\n }, {\n \"name\" : \"Shoes&Accessories Cadeau\",\n \"type\" : \"sagiftcard\"\n }, {\n \"name\" : \"Score Giftcard\",\n \"type\" : \"scoregiftcard\"\n }, {\n \"name\" : \"Premium SMS\",\n \"type\" : \"sms\"\n }, {\n \"name\" : \"SVS\",\n \"type\" : \"svs\"\n }, {\n \"name\" : \"TCS Test GiftCard\",\n \"type\" : \"tcstestgiftcard\"\n }, {\n \"name\" : \"The Sting Giftcard\",\n \"type\" : \"thestinggiftcard\"\n }, {\n \"name\" : \"Ukash\",\n \"type\" : \"ukash\"\n }, {\n \"name\" : \"UnionPay\",\n \"type\" : \"unionpay\"\n }, {\n \"name\" : \"Valuelink\",\n \"type\" : \"valuelink\"\n }, {\n \"name\" : \"V&D Cadeaukaart\",\n \"type\" : \"vdcadeaucard\"\n }, {\n \"name\" : \"Visa Checkout\",\n \"type\" : \"visacheckout\"\n }, {\n \"name\" : \"VVV Cadeaubon\",\n \"type\" : \"vvvcadeaubon\"\n }, {\n \"name\" : \"Webshop Giftcard\",\n \"type\" : \"webshopgiftcard\"\n }, {\n \"name\" : \"WE Fashion Giftcard\",\n \"type\" : \"wefashiongiftcard\"\n }, {\n \"name\" : \"Western Union\",\n \"type\" : \"westernunion\"\n }, {\n \"name\" : \"Winkel Cheque\",\n \"type\" : \"winkelcheque\"\n }, {\n \"name\" : \"Your Gift\",\n \"type\" : \"yourgift\"\n } ],\n \"storedPaymentMethods\" : [ {\n \"brand\" : \"visa\",\n \"expiryMonth\" : \"10\",\n \"expiryYear\" : \"30\",\n \"holderName\" : \"John Smith\",\n \"id\" : \"7219687191761347\",\n \"issuerName\" : \"ISSUER_NAME\",\n \"lastFour\" : \"1111\",\n \"name\" : \"VISA\",\n \"shopperEmail\" : \"john.smith@example.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"supportedRecurringProcessingModels\" : [ \"CardOnFile\", \"Subscription\", \"UnscheduledCardOnFile\" ],\n \"type\" : \"scheme\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentMethods" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\" : \"NL\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentMethods", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentMethods" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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. ", @@ -1538,692 +2811,1061 @@ { "name": "Make an Apple Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"applepay\",\n \"applePayToken\" : \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure 2 native authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"authenticationData\" : {\n \"threeDSRequestData\" : {\n \"nativeThreeDS\" : \"preferred\"\n }\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"{{$guid}}\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4035501428146300\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\",\n \"holderName\" : \"John Smith\"\n },\n \"authenticationData\" : {\n \"threeDSRequestData\" : {\n \"nativeThreeDS\" : \"preferred\"\n }\n },\n \"billingAddress\" : {\n \"country\" : \"US\",\n \"city\" : \"New York\",\n \"street\" : \"Redwood Block\",\n \"houseNumberOrName\" : \"37C\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"10039\"\n },\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperIP\" : \"192.0.2.1\",\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\" : \"nl-NL\",\n \"colorDepth\" : 24,\n \"screenHeight\" : 723,\n \"screenWidth\" : 1536,\n \"timeZoneOffset\" : 0,\n \"javaEnabled\" : true\n },\n \"channel\" : \"Web\",\n \"origin\" : \"https://your-company.com\",\n \"returnUrl\" : \"https://your-company.com/checkout/\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with 3D Secure redirect authentication", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4212345678901237\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"browserInfo\" : {\n \"userAgent\" : \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\" : \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\" : true,\n \"colorDepth\" : 10,\n \"screenHeight\" : 2000,\n \"screenWidth\" : 3000,\n \"timeZoneOffset\" : 5,\n \"language\" : \"en\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a card payment with unencrypted card details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"044925\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VEP3H\"\n },\n \"pspReference\" : \"993617895204576J\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\",\n \"cvc\" : \"737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a card payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"065696\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VIE9N\"\n },\n \"pspReference\" : \"993617895215577D\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Tokenize card details for one-off payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"082338\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VC172\"\n },\n \"pspReference\" : \"993617895195570C\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Google Pay payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"paywithgoogle\",\n \"googlePayToken\" : \"==Payload as retrieved from Google Pay response==\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"YourMerchantAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make an iDEAL payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"RedirectShopper\",\n \"action\" : {\n \"paymentMethodType\" : \"ideal\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\",\n \"method\" : \"GET\",\n \"type\" : \"redirect\"\n },\n \"paymentData\" : \"Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==\",\n \"redirect\" : {\n \"method\" : \"GET\",\n \"url\" : \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"ideal\",\n \"issuer\" : \"1121\"\n },\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Make a Klarna payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\" : {\n \"type\" : \"klarna\"\n },\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"returnUrl\" : \"https://www.your-company.com/...\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a one-off payment with a token and CVV", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8416038790273850\",\n \"encryptedSecurityCode\" : \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Make a subscription card payment with a token", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"storedPaymentMethodId\" : \"8316038796685850\"\n },\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\" : \"ContAuth\",\n \"recurringProcessingModel\" : \"Subscription\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"eci\" : \"N/A\",\n \"acquirerAccountCode\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\" : \"N/A\",\n \"threeDAuthenticated\" : \"false\",\n \"paymentMethodVariant\" : \"visa\",\n \"issuerBin\" : \"41111111\",\n \"payoutEligible\" : \"Y\",\n \"fraudManualReview\" : \"false\",\n \"threeDOffered\" : \"false\",\n \"threeDOfferedResponse\" : \"N/A\",\n \"authorisationMid\" : \"50\",\n \"fundsAvailability\" : \"I\",\n \"authorisedAmountCurrency\" : \"USD\",\n \"threeDAuthenticatedResponse\" : \"N/A\",\n \"avsResultRaw\" : \"5\",\n \"retry.attempt1.rawResponse\" : \"AUTHORISED\",\n \"paymentMethod\" : \"visa\",\n \"avsResult\" : \"5 No AVS data provided\",\n \"cardSummary\" : \"1111\",\n \"retry.attempt1.avsResultRaw\" : \"5\",\n \"networkTxReference\" : \"777718270854480\",\n \"expiryDate\" : \"3/2030\",\n \"cavvAlgorithm\" : \"N/A\",\n \"cardBin\" : \"411111\",\n \"alias\" : \"8915844059375211\",\n \"cvcResultRaw\" : \"M\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\" : \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\" : \"NL\",\n \"liabilityShift\" : \"false\",\n \"fraudResultType\" : \"GREEN\",\n \"authCode\" : \"035450\",\n \"cardHolderName\" : \"John Smith\",\n \"isCardCommercial\" : \"unknown\",\n \"PaymentAccountReference\" : \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\" : \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\" : \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\" : \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\" : \"40000\",\n \"issuerCountry\" : \"NL\",\n \"cvcResult\" : \"1 Matches\",\n \"retry.attempt1.responseCode\" : \"Approved\",\n \"aliasType\" : \"Default\",\n \"retry.attempt1.shopperInteraction\" : \"Ecommerce\",\n \"cardPaymentMethod\" : \"visa\",\n \"acquirerCode\" : \"YOUR_ACQUIRER_CODE\"\n },\n \"pspReference\" : \"PPKFQ89R6QRXGN82\",\n \"resultCode\" : \"Authorised\",\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"donationToken\" : \"81234567890123456...\",\n \"merchantReference\" : \"YOUR_ORDER_NUMBER\",\n \"paymentMethod\" : {\n \"brand\" : \"visa\",\n \"type\" : \"scheme\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\",\n \"costAllocationAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"type\" : \"PaymentFee\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Split a payment in a Classic Platforms integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"amount\" : {\n \"value\" : 6200,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 6000\n },\n \"type\" : \"MarketPlace\",\n \"account\" : \"151272963\",\n \"reference\" : \"6124145\",\n \"description\" : \"Porcelain Doll: Eliza (20cm)\"\n }, {\n \"amount\" : {\n \"value\" : 200\n },\n \"type\" : \"Commission\",\n \"reference\" : \"6124146\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] }, { "name": "Tokenize card details for a subscription", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"additionalData\" : {\n \"cvcResult\" : \"1 Matches\",\n \"authCode\" : \"098871\",\n \"avsResult\" : \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\" : \"9916178934434753\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"avsResultRaw\" : \"4\",\n \"cvcResultRaw\" : \"M\",\n \"refusalReasonRaw\" : \"AUTHORISED\",\n \"recurring.shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"acquirerCode\" : \"TestPmmAcquirer\",\n \"acquirerReference\" : \"8PQMP9VD896\"\n },\n \"pspReference\" : \"993617895199574A\",\n \"resultCode\" : \"Authorised\",\n \"merchantReference\" : \"string\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 1000\n },\n \"reference\" : \"Your order number\",\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"encryptedCardNumber\" : \"test_4111111111111111\",\n \"encryptedExpiryMonth\" : \"test_03\",\n \"encryptedExpiryYear\" : \"test_2030\",\n \"encryptedSecurityCode\" : \"test_737\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\" : true,\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"Subscription\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] } ] - } -, + }, { "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. ", @@ -2231,106 +3873,167 @@ { "name": "Submit the redirect result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"resultCode\" : \"Authorised\",\n \"pspReference\" : \"V4HZ4RBFJGXXGN82\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + ] }, { "name": "Submit 3D Secure 2 authentication result", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payments/details", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payments", - "details" - ], - "variable": [ - ], - "query": [ - ] - }, - "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. " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/details", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "details" + ], + "variable": [ + ], + "query": [ + ] + }, + "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. " +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -2338,202 +4041,437 @@ { "name": "Create a payment session", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2022-01-11T13:53:18+01:00\",\n \"id\" : \"CS451F2AB1ED897A94\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Create a payment session including Klarna fields", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"countryCode\" : \"SE\",\n \"dateOfBirth\" : \"1996-09-04T02:00:00+02:00\",\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"expiresAt\" : \"2022-01-11T13:57:52+01:00\",\n \"id\" : \"CSC52E9932D39ADAF3\",\n \"lineItems\" : [ {\n \"amountExcludingTax\" : 331,\n \"amountIncludingTax\" : 400,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\",\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"quantity\" : 1,\n \"taxAmount\" : 69,\n \"taxPercentage\" : 2100\n }, {\n \"amountExcludingTax\" : 248,\n \"amountIncludingTax\" : 300,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\",\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"quantity\" : 2,\n \"taxAmount\" : 52,\n \"taxPercentage\" : 2100\n } ],\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"returnUrl\" : \"https://example.org\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperLocale\" : \"en_US\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"socialSecurityNumber\" : \"0108\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"YOUR_ORDER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"SEK\",\n \"value\" : 1000\n },\n \"shopperLocale\" : \"en_US\",\n \"countryCode\" : \"SE\",\n \"telephoneNumber\" : \"+46 840 839 298\",\n \"shopperEmail\" : \"youremail@email.com\",\n \"shopperName\" : {\n \"firstName\" : \"Testperson-se\",\n \"lastName\" : \"Approved\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"billingAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"deliveryAddress\" : {\n \"city\" : \"Ankeborg\",\n \"country\" : \"SE\",\n \"houseNumberOrName\" : \"1\",\n \"postalCode\" : \"12345\",\n \"street\" : \"Stargatan\"\n },\n \"dateOfBirth\" : \"1996-09-04\",\n \"socialSecurityNumber\" : \"0108\",\n \"returnUrl\" : \"https://example.org\",\n \"lineItems\" : [ {\n \"quantity\" : 1,\n \"amountExcludingTax\" : 331,\n \"taxPercentage\" : 2100,\n \"description\" : \"Shoes\",\n \"id\" : \"Item #1\",\n \"taxAmount\" : 69,\n \"amountIncludingTax\" : 400,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n }, {\n \"quantity\" : 2,\n \"amountExcludingTax\" : 248,\n \"taxPercentage\" : 2100,\n \"description\" : \"Socks\",\n \"id\" : \"Item #2\",\n \"taxAmount\" : 52,\n \"amountIncludingTax\" : 300,\n \"productUrl\" : \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\" : \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Tokenize card details for one-off payments without asking shopper", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethodMode\" : \"enabled\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2022-01-11T13:56:05+01:00\",\n \"id\" : \"FJM726V375BV9D82\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"recurringProcessingModel\" : \"CardOnFile\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"storePaymentMethod\" : true,\n \"sessionData\" : \"Ab02b4c0!BQABAgBfYI29...\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethodMode\" : \"enabled\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"TestMerchantCheckout\",\n \"amount\" : {\n \"value\" : 100,\n \"currency\" : \"EUR\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\" : \"https://your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\" : \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\" : \"NL\",\n \"storePaymentMethodMode\" : \"enabled\",\n \"shopperInteraction\" : \"Ecommerce\",\n \"recurringProcessingModel\" : \"CardOnFile\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Split a payment between balance accounts", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"USD\",\n \"value\" : 40000\n },\n \"expiresAt\" : \"2023-06-26T11:01:55+02:00\",\n \"id\" : \"CSFCBC80570618EF2C\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"shopperLocale\" : \"en-US\",\n \"splits\" : [ {\n \"account\" : \"BA00000000000000000000001\",\n \"amount\" : {\n \"value\" : 39200\n },\n \"description\" : \"Your description for the sale amount\",\n \"reference\" : \"Your reference for the sale amount\",\n \"type\" : \"BalanceAccount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"description\" : \"Your description for the commission\",\n \"reference\" : \"Your reference for the commission\",\n \"type\" : \"Commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"description\" : \"Your description for the fees\",\n \"reference\" : \"Your reference for the fees\",\n \"type\" : \"PaymentFee\"\n } ],\n \"mode\" : \"embedded\",\n \"sessionData\" : \"Ab02b4c0!BQABAgCjTErwAztqXSFTiZtxZMjRLYkoGbPkmvCvDX1\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39200\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "name": "/sessions/:sessionId", "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.", @@ -2541,55 +4479,56 @@ { "name": "Get the result of a payment session", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sessions/:sessionId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sessions", - ":sessionId" - ], - "variable": [ - { - "key": "sessionId", - "value": "", - "description": "A unique identifier of the session." - } - ], - "query": [ - { - "key": "sessionResult", - "value": "sessionResult_example", - "description": "The `sessionResult` value from the Drop-in or Component.", - "disabled": false - } - ] - }, - "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId", + "value": "", + "description": "A unique identifier of the session." + } + ], + "query": [ + { + "key": "sessionResult", + "value": "sessionResult_example", + "description": "The `sessionResult` value from the Drop-in or Component.", + "disabled": false + } + ] + }, + "description": "Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path." +} + ,"response": [ + ] } ] } - ] }, { @@ -2602,55 +4541,113 @@ { "name": "Create a payment link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Idempotency-Key", - "value": "", - "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", - "disabled": true + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} + ,"response": [ + {"name": "Created - the request has succeeded.", + "code": 201, + "status": "Created", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"BRL\",\n \"value\" : 1250\n },\n \"billingAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"countryCode\" : \"BR\",\n \"deliveryAddress\" : {\n \"city\" : \"São Paulo\",\n \"country\" : \"BR\",\n \"houseNumberOrName\" : \"999\",\n \"postalCode\" : \"59000060\",\n \"stateOrProvince\" : \"SP\",\n \"street\" : \"Roque Petroni Jr\"\n },\n \"expiresAt\" : \"2022-10-28T09:16:22Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"YOUR_ORDER_NUMBER\",\n \"reusable\" : false,\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"id\" : \"PLE83C39B0A0DE0C1E\",\n \"status\" : \"active\",\n \"url\" : \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Idempotency-Key", + "value": "", + "description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"reference\" : \"{{$guid}}\",\n \"amount\" : {\n \"value\" : 1250,\n \"currency\" : \"BRL\"\n },\n \"countryCode\" : \"BR\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\" : \"test@email.com\",\n \"shopperLocale\" : \"pt-BR\",\n \"billingAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n },\n \"deliveryAddress\" : {\n \"street\" : \"Roque Petroni Jr\",\n \"postalCode\" : \"59000060\",\n \"city\" : \"São Paulo\",\n \"houseNumberOrName\" : \"999\",\n \"country\" : \"BR\",\n \"stateOrProvince\" : \"SP\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)." - } + ] } ] - } -, + }, { "name": "/paymentLinks/:linkId", "description": "Retrieves the payment link details using the payment link `id`.", @@ -2658,49 +4655,50 @@ { "name": "Get a payment link", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "description": "Retrieves the payment link details using the payment link `id`." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "description": "Retrieves the payment link details using the payment link `id`." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2708,55 +4706,113 @@ { "name": "Update the status of a payment link", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 8700\n },\n \"countryCode\" : \"NL\",\n \"expiresAt\" : \"2021-04-08T14:06:39Z\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\" : \"shopper-reference-ekvL83\",\n \"shopperLocale\" : \"hu-HU\",\n \"shopperReference\" : \"shopper-reference-LZfdWZ\",\n \"status\" : \"expired\",\n \"url\" : \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\" : \"PL61C53A8B97E6915A\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\" : \"expired\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentLinks/:linkId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentLinks", + ":linkId" + ], + "variable": [ + { + "key": "linkId", + "value": "", + "description": "Unique identifier of the payment link." + } + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\" : \"expired\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/paymentLinks/:linkId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "paymentLinks", - ":linkId" - ], - "variable": [ - { - "key": "linkId", - "value": "", - "description": "Unique identifier of the payment link." - } - ], - "query": [ - ] - }, - "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)." - } + ] } ] } - ] } ], diff --git a/postman/DataProtectionService-v1.json b/postman/DataProtectionService-v1.json index 457c83c..1626ac1 100644 --- a/postman/DataProtectionService-v1.json +++ b/postman/DataProtectionService-v1.json @@ -19,49 +19,50 @@ { "name": "Submit a Subject Erasure Request.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"forceErasure\": \"\",\n \"merchantAccount\": \"\",\n \"pspReference\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/requestSubjectErasure", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "requestSubjectErasure" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Sends the PSP reference containing the shopper data that should be deleted." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"forceErasure\": \"\",\n \"merchantAccount\": \"\",\n \"pspReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/requestSubjectErasure", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "requestSubjectErasure" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Sends the PSP reference containing the shopper data that should be deleted." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/DisputeService-v30.json b/postman/DisputeService-v30.json index f70a743..e6ce73a 100644 --- a/postman/DisputeService-v30.json +++ b/postman/DisputeService-v30.json @@ -19,49 +19,101 @@ { "name": "Accept a dispute", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/acceptDispute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "acceptDispute" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Accepts a specific dispute." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"disputeServiceResult\" : {\n \"success\" : true\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/acceptDispute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "acceptDispute" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Accepts a specific dispute." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/acceptDispute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "acceptDispute" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Accepts a specific dispute." - } + ] } ] - } -, + }, { "name": "/defendDispute", "description": "Defends a specific dispute.", @@ -69,49 +121,101 @@ { "name": "Defend a dispute", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"defenseReasonCode\" : \"SupplyDefenseMaterial\",\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/defendDispute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "defendDispute" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Defends a specific dispute." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"disputeServiceResult\" : {\n \"success\" : true\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"defenseReasonCode\" : \"SupplyDefenseMaterial\",\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/defendDispute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "defendDispute" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Defends a specific dispute." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"defenseReasonCode\" : \"SupplyDefenseMaterial\",\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/defendDispute", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "defendDispute" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Defends a specific dispute." - } + ] } ] - } -, + }, { "name": "/deleteDisputeDefenseDocument", "description": "Deletes a specific dispute defense document that was supplied earlier.", @@ -119,49 +223,101 @@ { "name": "Delete a dispute defense document", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"defenseDocumentType\" : \"DefenseMaterial\",\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/deleteDisputeDefenseDocument", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "deleteDisputeDefenseDocument" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Deletes a specific dispute defense document that was supplied earlier." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"disputeServiceResult\" : {\n \"success\" : true\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"defenseDocumentType\" : \"DefenseMaterial\",\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/deleteDisputeDefenseDocument", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "deleteDisputeDefenseDocument" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Deletes a specific dispute defense document that was supplied earlier." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"defenseDocumentType\" : \"DefenseMaterial\",\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/deleteDisputeDefenseDocument", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "deleteDisputeDefenseDocument" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Deletes a specific dispute defense document that was supplied earlier." - } + ] } ] - } -, + }, { "name": "/retrieveApplicableDefenseReasons", "description": "Returns a list of all applicable defense reasons to defend a specific dispute.", @@ -169,49 +325,101 @@ { "name": "Retrieve applicable defense reasons", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/retrieveApplicableDefenseReasons", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "retrieveApplicableDefenseReasons" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of all applicable defense reasons to defend a specific dispute." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"defenseReasons\" : [ {\n \"defenseDocumentTypes\" : [ {\n \"available\" : false,\n \"defenseDocumentTypeCode\" : \"TIDorInvoice\",\n \"requirementLevel\" : \"Optional\"\n }, {\n \"available\" : false,\n \"defenseDocumentTypeCode\" : \"GoodsNotReturned\",\n \"requirementLevel\" : \"Required\"\n } ],\n \"defenseReasonCode\" : \"GoodsNotReturned\",\n \"satisfied\" : false\n }, {\n \"defenseDocumentTypes\" : [ {\n \"available\" : false,\n \"defenseDocumentTypeCode\" : \"TIDorInvoice\",\n \"requirementLevel\" : \"Optional\"\n }, {\n \"available\" : false,\n \"defenseDocumentTypeCode\" : \"GoodsRepairedOrReplaced\",\n \"requirementLevel\" : \"Required\"\n } ],\n \"defenseReasonCode\" : \"GoodsRepairedOrReplaced\",\n \"satisfied\" : false\n }, {\n \"defenseDocumentTypes\" : [ {\n \"available\" : false,\n \"defenseDocumentTypeCode\" : \"GoodsWereAsDescribed\",\n \"requirementLevel\" : \"Required\"\n }, {\n \"available\" : false,\n \"defenseDocumentTypeCode\" : \"TIDorInvoice\",\n \"requirementLevel\" : \"Required\"\n } ],\n \"defenseReasonCode\" : \"GoodsWereAsDescribed\",\n \"satisfied\" : false\n }, {\n \"defenseDocumentTypes\" : [ {\n \"available\" : false,\n \"defenseDocumentTypeCode\" : \"TIDorInvoice\",\n \"requirementLevel\" : \"Optional\"\n }, {\n \"available\" : false,\n \"defenseDocumentTypeCode\" : \"DefenseMaterial\",\n \"requirementLevel\" : \"Required\"\n } ],\n \"defenseReasonCode\" : \"SupplyDefenseMaterial\",\n \"satisfied\" : false\n } ],\n \"disputeServiceResult\" : {\n \"success\" : true\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/retrieveApplicableDefenseReasons", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "retrieveApplicableDefenseReasons" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of all applicable defense reasons to defend a specific dispute." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/retrieveApplicableDefenseReasons", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "retrieveApplicableDefenseReasons" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns a list of all applicable defense reasons to defend a specific dispute." - } + ] } ] - } -, + }, { "name": "/supplyDefenseDocument", "description": "Supplies a specific dispute defense document.", @@ -219,49 +427,101 @@ { "name": "Supply dispute defense documents", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"defenseDocuments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"contentType\" : \"application/pdf\",\n \"defenseDocumentTypeCode\" : \"DefenseMaterial\"\n } ],\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/supplyDefenseDocument", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "supplyDefenseDocument" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Supplies a specific dispute defense document." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"disputeServiceResult\" : {\n \"success\" : true\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"defenseDocuments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"contentType\" : \"application/pdf\",\n \"defenseDocumentTypeCode\" : \"DefenseMaterial\"\n } ],\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/supplyDefenseDocument", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "supplyDefenseDocument" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Supplies a specific dispute defense document." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"defenseDocuments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"contentType\" : \"application/pdf\",\n \"defenseDocumentTypeCode\" : \"DefenseMaterial\"\n } ],\n \"disputePspReference\" : \"DZ4DPSHB4WD2WN82\",\n \"merchantAccountCode\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/supplyDefenseDocument", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "supplyDefenseDocument" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Supplies a specific dispute defense document." - } + ] } ] } - ] } ], diff --git a/postman/LegalEntityService-v1.json b/postman/LegalEntityService-v1.json index 5434961..2fda187 100644 --- a/postman/LegalEntityService-v1.json +++ b/postman/LegalEntityService-v1.json @@ -2,7 +2,7 @@ "info": { "name": "Legal Entity Management API (v1)", "description": { - "content": "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\n-H \"Content-Type: application/json\" \\n...\n```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws_123456@Scope.Company_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\n-H \"Content-Type: application/json\" \\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v1/legalEntities\n```\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://kyc-live.adyen.com/lem/v1`.\n\n", + "content": "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\n-H \"Content-Type: application/json\" \\n...\n```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws_123456@Scope.Company_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\n-H \"Content-Type: application/json\" \\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v1/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://kyc-live.adyen.com/lem/v1`.\n\n", "type": "text/markdown" }, "version": "1", @@ -14,207 +14,442 @@ "item": [ { "name": "/legalEntities", - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. ", "item": [ { "name": "Create a legal entity for an individual residing in the Netherlands", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for an individual residing in the US", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for a Dutch organization", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"signatory\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000002\",\n \"entityType\" : \"individual\",\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"name\" : \"Simone Hopper\",\n \"type\" : \"signatory\"\n } ],\n \"organization\" : {\n \"email\" : \"organization@example.com\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"legalName\" : \"Explorer Company based in NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"type\" : \"privateCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE00000000000000000000002\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"signatory\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"signatory\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for an organization in the US", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"taxExempt\" : false,\n \"type\" : \"privateCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] } ] - } -, + }, { "name": "/legalEntities/:id", "description": "Returns a legal entity.", @@ -222,49 +457,50 @@ { "name": "Get a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "description": "Returns a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns a legal entity." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -272,116 +508,245 @@ { "name": "Change a legal entity from an organization to an individual", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"name\" : {\n \"firstName\" : \"Explorer\",\n \"lastName\" : \"Company based in US\"\n },\n \"residentialAddress\" : {\n \"country\" : \"US\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Add entity associations to an organization", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000002\",\n \"entityType\" : \"individual\",\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"name\" : \"Simone Hopper\",\n \"type\" : \"uboThroughControl\"\n } ],\n \"organization\" : {\n \"email\" : \"john.doe@adyen.com\",\n \"phone\" : {\n \"countryCode\" : \"NL\",\n \"number\" : \"646467363\",\n \"type\" : \"mobile\"\n },\n \"description\" : \"FinTech\",\n \"doingBusinessAs\" : \"Adyen BV\",\n \"legalName\" : \"Adyen BV\",\n \"registeredAddress\" : {\n \"city\" : \"AMS\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1234EE\",\n \"stateOrProvince\" : \"NH\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"\",\n \"stockData\" : {\n \"marketIdentifier\" : \"ADYN\",\n \"stockNumber\" : \"NL012345ABC4\",\n \"tickerSymbol\" : \"ADYN.M\"\n },\n \"taxExempt\" : false,\n \"type\" : \"listedPublicCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE00000000000000000000002\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/businessLines", "description": "Returns the business lines owned by a legal entity.", @@ -389,50 +754,51 @@ { "name": "Get all business lines under a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/businessLines", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "businessLines" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "description": "Returns the business lines owned by a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "businessLines" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the business lines owned by a legal entity." +} + ,"response": [ + ] } ] } - ] }, { @@ -440,155 +806,216 @@ "item": [ { "name": "/legalEntities/:id/onboardingLinks", - "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. ", "item": [ { "name": "Create a hosted onboarding link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"themeId\" : \"YOUR_THEME_ID\",\n \"redirectUrl\" : \"https://your.redirect-url.com/\",\n \"locale\" : \"nl-NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "onboardingLinks" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity" + } + ], + "query": [ + ] + }, + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"url\" : \"https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"themeId\" : \"YOUR_THEME_ID\",\n \"redirectUrl\" : \"https://your.redirect-url.com/\",\n \"locale\" : \"nl-NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "onboardingLinks" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity" + } + ], + "query": [ + ] + }, + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"themeId\" : \"YOUR_THEME_ID\",\n \"redirectUrl\" : \"https://your.redirect-url.com/\",\n \"locale\" : \"nl-NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "onboardingLinks" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity" - } - ], - "query": [ - ] - }, - "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] } ] - } -, + }, { "name": "/themes", - "description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Returns a list of hosted onboarding page themes. ", "item": [ { "name": "Get a list of hosted onboarding page themes", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/themes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "themes" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of hosted onboarding page themes. " +} + ,"response": [ + ] } ] - } -, + }, { "name": "/themes/:id", - "description": "Returns the details of the theme identified in the path.>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Returns the details of the theme identified in the path.", "item": [ { "name": "Get an onboarding link theme", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/themes/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "themes", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the theme" - } - ], - "query": [ - ] - }, - "description": "Returns the details of the theme identified in the path.>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the theme" + } + ], + "query": [ + ] + }, + "description": "Returns the details of the theme identified in the path." +} + ,"response": [ + ] } ] } - ] }, { @@ -596,97 +1023,202 @@ "item": [ { "name": "/businessLines", - "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. ", "item": [ { "name": "Create a business line for a business account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"capability\" : \"issueBankAccount\",\n \"industryCode\" : \"4531\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"type\" : \"business\",\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"capability\" : \"issueBankAccount\",\n \"industryCode\" : \"4531\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\",\n \"type\" : \"business\"\n },\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"id\" : \"SE322KT223222D5FJ7TJN2986\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"capability\" : \"issueBankAccount\",\n \"industryCode\" : \"4531\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"type\" : \"business\",\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"capability\" : \"issueBankAccount\",\n \"industryCode\" : \"4531\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"type\" : \"business\",\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a business line for receiving payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"capability\" : \"receivePayments\",\n \"salesChannels\" : [ \"eCommerce\", \"ecomMoto\" ],\n \"industryCode\" : \"339E\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"webData\" : [ {\n \"webAddress\" : \"https://yoururl.com\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"capability\" : \"receivePayments\",\n \"industryCode\" : \"339E\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"salesChannels\" : [ \"eCommerce\", \"ecomMoto\" ],\n \"webData\" : [ {\n \"webAddress\" : \"https://yoururl.com\"\n } ],\n \"id\" : \"SE322KT223222D5FJ7TJN2986\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"capability\" : \"receivePayments\",\n \"salesChannels\" : [ \"eCommerce\", \"ecomMoto\" ],\n \"industryCode\" : \"339E\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"webData\" : [ {\n \"webAddress\" : \"https://yoururl.com\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"capability\" : \"receivePayments\",\n \"salesChannels\" : [ \"eCommerce\", \"ecomMoto\" ],\n \"industryCode\" : \"339E\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"webData\" : [ {\n \"webAddress\" : \"https://yoururl.com\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] } ] - } -, + }, { "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.", @@ -694,49 +1226,50 @@ { "name": "Delete a business line", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the business line to be deleted." - } - ], - "query": [ - ] - }, - "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." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line to be deleted." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/businessLines/:id", "description": "Returns the detail of a business line.", @@ -744,49 +1277,50 @@ { "name": "Get a business line", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the business line." - } - ], - "query": [ - ] - }, - "description": "Returns the detail of a business line." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Returns the detail of a business line." +} + ,"response": [ + ] } ] } - ] }, { @@ -799,55 +1333,113 @@ { "name": "Upload a document", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"fileName\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n },\n \"id\" : \"SE322JV223222F5GV2N9L8GDK\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs." - } + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Deletes a document.", @@ -855,49 +1447,50 @@ { "name": "Delete a document", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document to be deleted." - } - ], - "query": [ - ] - }, - "description": "Deletes a document." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a document." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Returns a document.", @@ -905,55 +1498,56 @@ { "name": "Get a document", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document." - } - ], - "query": [ - { - "key": "skipContent", - "value": "true", - "description": "Do not load document content while fetching the document.", - "disabled": true - } - ] - }, - "description": "Returns a document." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document." + } + ], + "query": [ + { + "key": "skipContent", + "value": "true", + "description": "Do not load document content while fetching the document.", + "disabled": true + } + ] + }, + "description": "Returns a document." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs.", @@ -961,61 +1555,125 @@ { "name": "Update a document", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be updated." + } + ], + "query": [ + ] + }, + "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"proofOfIndustry\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Proof of industry for Example Company\",\n \"fileName\" : \"Proof of industry for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n },\n \"id\" : \"SE322JV223222F5GV2N9L8GDK\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be updated." + } + ], + "query": [ + ] + }, + "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document to be updated." - } - ], - "query": [ - ] - }, - "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs." - } + ] } ] } - ] }, { @@ -1028,56 +1686,115 @@ { "name": "Get the Terms of Service document", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns the Terms of Service document for a legal entity." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\",\n \"document\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"termsOfServiceDocumentId\" : \"abc123\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns the Terms of Service document for a legal entity." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfService", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfService" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - } - ], - "query": [ - ] - }, - "description": "Returns the Terms of Service document for a legal entity." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/termsOfService/:termsofservicedocumentid", "description": "Accepts Terms of Service.", @@ -1085,62 +1802,127 @@ { "name": "Accept the Terms of Service document", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"acceptedBy\" : \"LE00000000000000000000002\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService", + ":termsofservicedocumentid" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + }, + { + "key": "termsofservicedocumentid", + "value": "", + "description": "The unique identifier of the Terms of Service document." + } + ], + "query": [ + ] + }, + "description": "Accepts Terms of Service." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"acceptedBy\" : \"LE00000000000000000000002\",\n \"id\" : \"TOSA000AB00000000B2AAAB2BA0AA0\",\n \"language\" : \"en\",\n \"termsOfServiceDocumentId\" : \"abc123\",\n \"type\" : \"adyenIssuing\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"acceptedBy\" : \"LE00000000000000000000002\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService", + ":termsofservicedocumentid" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + }, + { + "key": "termsofservicedocumentid", + "value": "", + "description": "The unique identifier of the Terms of Service document." + } + ], + "query": [ + ] + }, + "description": "Accepts Terms of Service." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"acceptedBy\" : \"LE00000000000000000000002\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfService", - ":termsofservicedocumentid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - }, - { - "key": "termsofservicedocumentid", - "value": "", - "description": "The unique identifier of the Terms of Service document." - } - ], - "query": [ - ] - }, - "description": "Accepts Terms of Service." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/termsOfServiceAcceptanceInfos", "description": "Returns Terms of Service information for a legal entity.", @@ -1148,50 +1930,51 @@ { "name": "Get Terms of Service information for a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceAcceptanceInfos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfServiceAcceptanceInfos" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - } - ], - "query": [ - ] - }, - "description": "Returns Terms of Service information for a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceAcceptanceInfos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfServiceAcceptanceInfos" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns Terms of Service information for a legal entity." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/legalEntities/:id/termsOfServiceStatus", "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity.", @@ -1199,50 +1982,51 @@ { "name": "Get Terms of Service status", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceStatus", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfServiceStatus" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - } - ], - "query": [ - ] - }, - "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceStatus", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfServiceStatus" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity." +} + ,"response": [ + ] } ] } - ] }, { @@ -1255,104 +2039,221 @@ { "name": "Add a EUR bank account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\",\n \"trustedSource\" : false\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"id\" : \"SE576BH223222F5GJVKHH6BDT\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." - } + ] }, { "name": "Add a USD bank account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"accountNumber\" : \"0000000123\",\n \"branchCode\" : \"121202211\",\n \"accountType\" : \"checking\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"accountNumber\" : \"0000000123\",\n \"accountType\" : \"checking\",\n \"branchCode\" : \"121202211\",\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"trustedSource\" : false\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"id\" : \"SE322JV223222F5GJVKHH8DTC\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"accountNumber\" : \"0000000123\",\n \"branchCode\" : \"121202211\",\n \"accountType\" : \"checking\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"accountNumber\" : \"0000000123\",\n \"branchCode\" : \"121202211\",\n \"accountType\" : \"checking\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." - } + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Deletes a transfer instrument.", @@ -1360,49 +2261,50 @@ { "name": "Delete a transfer instrument", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument to be deleted." - } - ], - "query": [ - ] - }, - "description": "Deletes a transfer instrument." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a transfer instrument." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Returns the details of a transfer instrument.", @@ -1410,49 +2312,50 @@ { "name": "Get a transfer instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a transfer instrument." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a transfer instrument." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Updates a transfer instrument.", @@ -1460,61 +2363,125 @@ { "name": "Update a transfer instrument", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bankAccount\" : {\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL02ABNA0123456789\"\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a transfer instrument." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL02ABNA0123456789\"\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"id\" : \"SE576BH223222F5GJVKHH6BDT\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bankAccount\" : {\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL02ABNA0123456789\"\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a transfer instrument." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bankAccount\" : {\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL02ABNA0123456789\"\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument." - } - ], - "query": [ - ] - }, - "description": "Updates a transfer instrument." - } + ] } ] } - ] }, { @@ -1527,50 +2494,51 @@ { "name": "Get PCI questionnaire details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity to get PCI questionnaire information." - } - ], - "query": [ - ] - }, - "description": "Get a list of signed PCI questionnaires." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity to get PCI questionnaire information." + } + ], + "query": [ + ] + }, + "description": "Get a list of signed PCI questionnaires." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/legalEntities/:id/pciQuestionnaires/:pciid", "description": "Returns the signed PCI questionnaire.", @@ -1578,56 +2546,57 @@ { "name": "Get PCI questionnaire", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/:pciid", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires", - ":pciid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The legal entity ID of the individual who signed the PCI questionnaire." - }, - { - "key": "pciid", - "value": "", - "description": "The unique identifier of the signed PCI questionnaire." - } - ], - "query": [ - ] - }, - "description": "Returns the signed PCI questionnaire." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/:pciid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + ":pciid" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The legal entity ID of the individual who signed the PCI questionnaire." + }, + { + "key": "pciid", + "value": "", + "description": "The unique identifier of the signed PCI questionnaire." + } + ], + "query": [ + ] + }, + "description": "Returns the signed PCI questionnaire." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -1635,57 +2604,117 @@ { "name": "Generate PCI questionnaires", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"language\" : \"fr\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "generatePciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity to get PCI questionnaire information." + } + ], + "query": [ + ] + }, + "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"language\" : \"fr\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"language\" : \"fr\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "generatePciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity to get PCI questionnaire information." + } + ], + "query": [ + ] + }, + "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"language\" : \"fr\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires", - "generatePciTemplates" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity to get PCI questionnaire information." - } - ], - "query": [ - ] - }, - "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/pciQuestionnaires/signPciTemplates", "description": "Signs the required PCI questionnaire.", @@ -1693,57 +2722,117 @@ { "name": "Sign PCI questionnaires", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"signedBy\" : \"LE00000000000000000000002\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "signPciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The legal entity ID of the user that has a contractual relationship with your platform." + } + ], + "query": [ + ] + }, + "description": "Signs the required PCI questionnaire." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pciQuestionnaireIds\" : [ \"PCID422GZ22322565HHMH48CW63CPH\", \"PCID422GZ22322565HHMH49CW75Z9H\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"signedBy\" : \"LE00000000000000000000002\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "signPciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The legal entity ID of the user that has a contractual relationship with your platform." + } + ], + "query": [ + ] + }, + "description": "Signs the required PCI questionnaire." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"signedBy\" : \"LE00000000000000000000002\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires", - "signPciTemplates" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The legal entity ID of the user that has a contractual relationship with your platform." - } - ], - "query": [ - ] - }, - "description": "Signs the required PCI questionnaire." - } + ] } ] } - ] } ], diff --git a/postman/LegalEntityService-v2.json b/postman/LegalEntityService-v2.json index 304631a..9424a6d 100644 --- a/postman/LegalEntityService-v2.json +++ b/postman/LegalEntityService-v2.json @@ -2,7 +2,7 @@ "info": { "name": "Legal Entity Management API (v2)", "description": { - "content": "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\n-H \"Content-Type: application/json\" \\n...\n```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws_123456@Scope.Company_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\n-H \"Content-Type: application/json\" \\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v2/legalEntities\n```\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n", + "content": "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\n-H \"Content-Type: application/json\" \\n...\n```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws_123456@Scope.Company_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\n-H \"Content-Type: application/json\" \\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v2/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n", "type": "text/markdown" }, "version": "2", @@ -14,354 +14,766 @@ "item": [ { "name": "/legalEntities", - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. ", "item": [ { "name": "Create a legal entity for an individual residing in the Netherlands", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for an individual residing in the US", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for a Dutch organization", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"signatory\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000002\",\n \"entityType\" : \"individual\",\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"name\" : \"Simone Hopper\",\n \"type\" : \"signatory\"\n } ],\n \"organization\" : {\n \"email\" : \"organization@example.com\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"legalName\" : \"Explorer Company based in NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"type\" : \"privateCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE00000000000000000000002\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"signatory\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"signatory\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for an organization in the US", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"type\" : \"privateCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for a Dutch sole proprietor", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\" : \"NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\" : \"NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n },\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\" : \"NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\" : \"NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for a sole proprietor in the US", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\" : \"US\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\" : \"US\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n },\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\" : \"US\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\" : \"US\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for a trust in Australia", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"trust\",\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678123\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"trust\" : {\n \"countryOfGoverningLaw\" : \"AU\",\n \"doingBusinessAs\" : \"West's Store\",\n \"name\" : \"Example Trust\",\n \"registeredAddress\" : {\n \"city\" : \"Sydney\",\n \"country\" : \"AU\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"street\" : \"Winfield Avenue\"\n },\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"number\" : \"12345678901\",\n \"type\" : \"ABN\"\n } ],\n \"type\" : \"fixedUnitTrust\",\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\",\n \"reference\" : \"SE322KH223222J5HJ6JRB75HQ\"\n } ]\n },\n \"type\" : \"trust\",\n \"id\" : \"LE322KH223222J5HJ6JRB75C5\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"trust\",\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678123\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"trust\",\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678123\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] } ] - } -, + }, { "name": "/legalEntities/:id", "description": "Returns a legal entity.", @@ -369,49 +781,50 @@ { "name": "Get a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "description": "Returns a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns a legal entity." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -419,281 +832,605 @@ { "name": "Change a legal entity from an organization to an individual", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"name\" : {\n \"firstName\" : \"Explorer\",\n \"lastName\" : \"Company based in US\"\n },\n \"residentialAddress\" : {\n \"country\" : \"US\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Add entity associations to an organization", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000001\",\n \"entityType\" : \"individual\",\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"name\" : \"Simone Hopper\",\n \"type\" : \"uboThroughControl\"\n } ],\n \"organization\" : {\n \"email\" : \"john.doe@adyen.com\",\n \"phone\" : {\n \"countryCode\" : \"NL\",\n \"number\" : \"646467363\",\n \"type\" : \"mobile\"\n },\n \"description\" : \"FinTech\",\n \"doingBusinessAs\" : \"Adyen BV\",\n \"legalName\" : \"Adyen BV\",\n \"registeredAddress\" : {\n \"city\" : \"AMS\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1234EE\",\n \"stateOrProvince\" : \"NH\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"\",\n \"stockData\" : {\n \"marketIdentifier\" : \"ADYN\",\n \"stockNumber\" : \"NL012345ABC4\",\n \"tickerSymbol\" : \"ADYN.M\"\n },\n \"type\" : \"listedPublicCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Add entity associations to a sole proprietorship", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"soleProprietorship\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000001\",\n \"entityType\" : \"soleProprietorship\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"soleProprietorship\"\n } ],\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"soleProprietorship\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"soleProprietorship\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Associate a trust member with a trust", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"protector\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000001\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"name\" : \"Simone Hopper\",\n \"type\" : \"protector\"\n } ],\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678901\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n },\n \"type\" : \"trust\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"protector\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"protector\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Associate an exempt settlor with a trust", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"settlor\",\n \"entityType\" : \"individual\",\n \"settlorExemptionReason\" : [ \"deceased\", \"professionalServiceProvider\" ]\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000001\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"settlor\",\n \"entityType\" : \"individual\",\n \"settlorExemptionReason\" : [ \"deceased\", \"professionalServiceProvider\" ]\n } ],\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678901\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n },\n \"type\" : \"trust\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"settlor\",\n \"entityType\" : \"individual\",\n \"settlorExemptionReason\" : [ \"deceased\", \"professionalServiceProvider\" ]\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"settlor\",\n \"entityType\" : \"individual\",\n \"settlorExemptionReason\" : [ \"deceased\", \"professionalServiceProvider\" ]\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/businessLines", "description": "Returns the business lines owned by a legal entity.", @@ -701,50 +1438,51 @@ { "name": "Get all business lines under a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/businessLines", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "businessLines" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "description": "Returns the business lines owned by a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "businessLines" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the business lines owned by a legal entity." +} + ,"response": [ + ] } ] } - ] }, { @@ -752,155 +1490,216 @@ "item": [ { "name": "/legalEntities/:id/onboardingLinks", - "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. ", "item": [ { "name": "Create a hosted onboarding link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"themeId\" : \"YOUR_THEME_ID\",\n \"redirectUrl\" : \"https://your.redirect-url.com/\",\n \"locale\" : \"nl-NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "onboardingLinks" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity" + } + ], + "query": [ + ] + }, + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"url\" : \"https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"themeId\" : \"YOUR_THEME_ID\",\n \"redirectUrl\" : \"https://your.redirect-url.com/\",\n \"locale\" : \"nl-NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "onboardingLinks" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity" + } + ], + "query": [ + ] + }, + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"themeId\" : \"YOUR_THEME_ID\",\n \"redirectUrl\" : \"https://your.redirect-url.com/\",\n \"locale\" : \"nl-NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "onboardingLinks" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity" - } - ], - "query": [ - ] - }, - "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] } ] - } -, + }, { "name": "/themes", - "description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Returns a list of hosted onboarding page themes. ", "item": [ { "name": "Get a list of hosted onboarding page themes", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/themes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "themes" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of hosted onboarding page themes. " +} + ,"response": [ + ] } ] - } -, + }, { "name": "/themes/:id", - "description": "Returns the details of the theme identified in the path.>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Returns the details of the theme identified in the path.", "item": [ { "name": "Get an onboarding link theme", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/themes/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "themes", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the theme" - } - ], - "query": [ - ] - }, - "description": "Returns the details of the theme identified in the path.>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the theme" + } + ], + "query": [ + ] + }, + "description": "Returns the details of the theme identified in the path." +} + ,"response": [ + ] } ] } - ] }, { @@ -908,54 +1707,106 @@ "item": [ { "name": "/businessLines", - "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. ", "item": [ { "name": "Create a business line for a business account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"capability\" : \"issueBankAccount\",\n \"industryCode\" : \"4531\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"type\" : \"business\",\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"capability\" : \"issueBankAccount\",\n \"industryCode\" : \"4531\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\",\n \"type\" : \"business\"\n },\n \"webData\" : [ {\n \"webAddress\" : \"https://www.example.com\",\n \"webAddressId\" : \"SE966LI345672J5H8V87B3FGH\"\n } ],\n \"id\" : \"SE322JV223222F5GVGMLNB83F\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"capability\" : \"issueBankAccount\",\n \"industryCode\" : \"4531\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"type\" : \"business\",\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"capability\" : \"issueBankAccount\",\n \"industryCode\" : \"4531\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"type\" : \"business\",\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] } ] - } -, + }, { "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.", @@ -963,49 +1814,50 @@ { "name": "Delete a business line", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the business line to be deleted." - } - ], - "query": [ - ] - }, - "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." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line to be deleted." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/businessLines/:id", "description": "Returns the detail of a business line.", @@ -1013,49 +1865,50 @@ { "name": "Get a business line", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the business line." - } - ], - "query": [ - ] - }, - "description": "Returns the detail of a business line." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Returns the detail of a business line." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/businessLines/:id", "description": "Updates a business line.", @@ -1063,55 +1916,113 @@ { "name": "Update a business line", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"industryCode\" : \"55\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.example.com\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Updates a business line." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"capability\" : \"issueBankAccount\",\n \"industryCode\" : \"55\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\",\n \"type\" : \"business\"\n },\n \"webData\" : [ {\n \"webAddress\" : \"https://www.example.com\",\n \"webAddressId\" : \"SE890CG45905K5H&M90J7MPY\"\n } ],\n \"id\" : \"SE322JV223222F5GVGMLNB83F\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"industryCode\" : \"55\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.example.com\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Updates a business line." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"industryCode\" : \"55\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.example.com\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the business line." - } - ], - "query": [ - ] - }, - "description": "Updates a business line." - } + ] } ] } - ] }, { @@ -1124,55 +2035,113 @@ { "name": "Upload a document", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"fileName\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n },\n \"id\" : \"SE322JV223222F5GV2N9L8GDK\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs." - } + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Deletes a document.", @@ -1180,49 +2149,50 @@ { "name": "Delete a document", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document to be deleted." - } - ], - "query": [ - ] - }, - "description": "Deletes a document." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a document." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Returns a document.", @@ -1230,55 +2200,56 @@ { "name": "Get a document", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document." - } - ], - "query": [ - { - "key": "skipContent", - "value": "true", - "description": "Do not load document content while fetching the document.", - "disabled": true - } - ] - }, - "description": "Returns a document." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document." + } + ], + "query": [ + { + "key": "skipContent", + "value": "true", + "description": "Do not load document content while fetching the document.", + "disabled": true + } + ] + }, + "description": "Returns a document." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs.", @@ -1286,61 +2257,125 @@ { "name": "Update a document", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be updated." + } + ], + "query": [ + ] + }, + "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"proofOfIndustry\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Proof of industry for Example Company\",\n \"fileName\" : \"Proof of industry for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n },\n \"id\" : \"SE322JV223222F5GV2N9L8GDK\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be updated." + } + ], + "query": [ + ] + }, + "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document to be updated." - } - ], - "query": [ - ] - }, - "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs." - } + ] } ] } - ] }, { @@ -1353,56 +2388,115 @@ { "name": "Get the Terms of Service document", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns the Terms of Service document for a legal entity." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\",\n \"document\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"termsOfServiceDocumentId\" : \"abc123\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns the Terms of Service document for a legal entity." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfService", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfService" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - } - ], - "query": [ - ] - }, - "description": "Returns the Terms of Service document for a legal entity." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/termsOfService/:termsofservicedocumentid", "description": "Accepts Terms of Service.", @@ -1410,62 +2504,127 @@ { "name": "Accept the Terms of Service document", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"acceptedBy\" : \"LE00000000000000000000002\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService", + ":termsofservicedocumentid" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + }, + { + "key": "termsofservicedocumentid", + "value": "", + "description": "The unique identifier of the Terms of Service document." + } + ], + "query": [ + ] + }, + "description": "Accepts Terms of Service." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"acceptedBy\" : \"LE00000000000000000000002\",\n \"id\" : \"TOSA000AB00000000B2AAAB2BA0AA0\",\n \"language\" : \"en\",\n \"termsOfServiceDocumentId\" : \"abc123\",\n \"type\" : \"adyenIssuing\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"acceptedBy\" : \"LE00000000000000000000002\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService", + ":termsofservicedocumentid" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + }, + { + "key": "termsofservicedocumentid", + "value": "", + "description": "The unique identifier of the Terms of Service document." + } + ], + "query": [ + ] + }, + "description": "Accepts Terms of Service." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"acceptedBy\" : \"LE00000000000000000000002\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfService", - ":termsofservicedocumentid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - }, - { - "key": "termsofservicedocumentid", - "value": "", - "description": "The unique identifier of the Terms of Service document." - } - ], - "query": [ - ] - }, - "description": "Accepts Terms of Service." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/termsOfServiceAcceptanceInfos", "description": "Returns Terms of Service information for a legal entity.", @@ -1473,50 +2632,51 @@ { "name": "Get Terms of Service information for a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceAcceptanceInfos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfServiceAcceptanceInfos" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - } - ], - "query": [ - ] - }, - "description": "Returns Terms of Service information for a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceAcceptanceInfos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfServiceAcceptanceInfos" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns Terms of Service information for a legal entity." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/legalEntities/:id/termsOfServiceStatus", "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity.", @@ -1524,50 +2684,51 @@ { "name": "Get Terms of Service status", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceStatus", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfServiceStatus" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - } - ], - "query": [ - ] - }, - "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceStatus", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfServiceStatus" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity." +} + ,"response": [ + ] } ] } - ] }, { @@ -1580,104 +2741,221 @@ { "name": "Add a EUR bank account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\",\n \"trustedSource\" : false\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\",\n \"trustedSource\" : false\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"capabilities\" : {\n \"sendToTransferInstrument\" : {\n \"allowed\" : false,\n \"requested\" : true,\n \"verificationStatus\" : \"pending\"\n }\n },\n \"id\" : \"SE322KH223222F5GXZFNM3BGP\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\",\n \"trustedSource\" : false\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL62ABNA0000000123\",\n \"trustedSource\" : false\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." - } + ] }, { "name": "Add a USD bank account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"accountNumber\" : \"0000000123\",\n \"branchCode\" : \"121202211\",\n \"accountType\" : \"checking\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"accountNumber\" : \"0000000123\",\n \"accountType\" : \"checking\",\n \"branchCode\" : \"121202211\",\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"trustedSource\" : false\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"capabilities\" : {\n \"sendToTransferInstrument\" : {\n \"allowed\" : false,\n \"requested\" : true,\n \"verificationStatus\" : \"pending\"\n }\n },\n \"id\" : \"SE322JV223222F5GJVKHH8DTC\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"accountNumber\" : \"0000000123\",\n \"branchCode\" : \"121202211\",\n \"accountType\" : \"checking\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"countryCode\" : \"US\",\n \"currencyCode\" : \"USD\",\n \"accountNumber\" : \"0000000123\",\n \"branchCode\" : \"121202211\",\n \"accountType\" : \"checking\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." - } + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Deletes a transfer instrument.", @@ -1685,49 +2963,50 @@ { "name": "Delete a transfer instrument", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument to be deleted." - } - ], - "query": [ - ] - }, - "description": "Deletes a transfer instrument." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a transfer instrument." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Returns the details of a transfer instrument.", @@ -1735,49 +3014,50 @@ { "name": "Get a transfer instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a transfer instrument." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a transfer instrument." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Updates a transfer instrument.", @@ -1785,61 +3065,125 @@ { "name": "Update a transfer instrument", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bankAccount\" : {\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL02ABNA0123456789\"\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a transfer instrument." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"countryCode\" : \"NL\",\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL02ABNA0123456789\"\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"id\" : \"SE576BH223222F5GJVKHH6BDT\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bankAccount\" : {\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL02ABNA0123456789\"\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a transfer instrument." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bankAccount\" : {\n \"currencyCode\" : \"EUR\",\n \"iban\" : \"NL02ABNA0123456789\"\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument." - } - ], - "query": [ - ] - }, - "description": "Updates a transfer instrument." - } + ] } ] } - ] }, { @@ -1852,50 +3196,51 @@ { "name": "Get PCI questionnaire details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity to get PCI questionnaire information." - } - ], - "query": [ - ] - }, - "description": "Get a list of signed PCI questionnaires." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity to get PCI questionnaire information." + } + ], + "query": [ + ] + }, + "description": "Get a list of signed PCI questionnaires." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/legalEntities/:id/pciQuestionnaires/:pciid", "description": "Returns the signed PCI questionnaire.", @@ -1903,56 +3248,57 @@ { "name": "Get PCI questionnaire", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/:pciid", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires", - ":pciid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The legal entity ID of the individual who signed the PCI questionnaire." - }, - { - "key": "pciid", - "value": "", - "description": "The unique identifier of the signed PCI questionnaire." - } - ], - "query": [ - ] - }, - "description": "Returns the signed PCI questionnaire." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/:pciid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + ":pciid" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The legal entity ID of the individual who signed the PCI questionnaire." + }, + { + "key": "pciid", + "value": "", + "description": "The unique identifier of the signed PCI questionnaire." + } + ], + "query": [ + ] + }, + "description": "Returns the signed PCI questionnaire." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -1960,57 +3306,117 @@ { "name": "Generate PCI questionnaires", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"language\" : \"fr\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "generatePciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity to get PCI questionnaire information." + } + ], + "query": [ + ] + }, + "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"language\" : \"fr\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"language\" : \"fr\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "generatePciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity to get PCI questionnaire information." + } + ], + "query": [ + ] + }, + "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"language\" : \"fr\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires", - "generatePciTemplates" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity to get PCI questionnaire information." - } - ], - "query": [ - ] - }, - "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/pciQuestionnaires/signPciTemplates", "description": "Signs the required PCI questionnaire.", @@ -2018,57 +3424,117 @@ { "name": "Sign PCI questionnaires", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"signedBy\" : \"LE00000000000000000000002\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "signPciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The legal entity ID of the user that has a contractual relationship with your platform." + } + ], + "query": [ + ] + }, + "description": "Signs the required PCI questionnaire." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pciQuestionnaireIds\" : [ \"PCID422GZ22322565HHMH48CW63CPH\", \"PCID422GZ22322565HHMH49CW75Z9H\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"signedBy\" : \"LE00000000000000000000002\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "signPciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The legal entity ID of the user that has a contractual relationship with your platform." + } + ], + "query": [ + ] + }, + "description": "Signs the required PCI questionnaire." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"signedBy\" : \"LE00000000000000000000002\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires", - "signPciTemplates" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The legal entity ID of the user that has a contractual relationship with your platform." - } - ], - "query": [ - ] - }, - "description": "Signs the required PCI questionnaire." - } + ] } ] } - ] } ], diff --git a/postman/LegalEntityService-v3.json b/postman/LegalEntityService-v3.json index 78d934e..7a3e82a 100644 --- a/postman/LegalEntityService-v3.json +++ b/postman/LegalEntityService-v3.json @@ -2,7 +2,7 @@ "info": { "name": "Legal Entity Management API (v3)", "description": { - "content": "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\n-H \"Content-Type: application/json\" \\n...\n```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws_123456@Scope.Company_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\n-H \"Content-Type: application/json\" \\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v3/legalEntities\n```\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://kyc-live.adyen.com/lem/v3`.\n\n", + "content": "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\n-H \"Content-Type: application/json\" \\n...\n```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws_123456@Scope.Company_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\n-H \"Content-Type: application/json\" \\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v3/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://kyc-live.adyen.com/lem/v3`.\n\n", "type": "text/markdown" }, "version": "3", @@ -14,354 +14,766 @@ "item": [ { "name": "/legalEntities", - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. ", "item": [ { "name": "Create a legal entity for an individual residing in the Netherlands", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for an individual residing in the US", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\",\n \"individual\" : {\n \"residentialAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"phone\" : {\n \"number\" : \"+14153671502\",\n \"type\" : \"mobile\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"email\" : \"s.eller@example.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for a Dutch organization", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"signatory\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000002\",\n \"entityType\" : \"individual\",\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"name\" : \"Simone Hopper\",\n \"type\" : \"signatory\"\n } ],\n \"organization\" : {\n \"email\" : \"organization@example.com\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"legalName\" : \"Explorer Company based in NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"type\" : \"privateCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE00000000000000000000002\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"signatory\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in NL\",\n \"doingBusinessAs\" : \"API Company Trading\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"34179503\",\n \"email\" : \"organization@example.com\"\n },\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"signatory\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for an organization in the US", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n },\n \"type\" : \"privateCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"organization\",\n \"organization\" : {\n \"legalName\" : \"Explorer Company based in US\",\n \"registrationNumber\" : \"101002749\",\n \"type\" : \"privateCompany\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for a Dutch sole proprietor", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\" : \"NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\" : \"NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n },\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\" : \"NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\" : \"NL\",\n \"registeredAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for a sole proprietor in the US", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\" : \"US\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\" : \"US\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n },\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\" : \"US\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"soleProprietorship\",\n \"soleProprietorship\" : {\n \"name\" : \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\" : \"US\",\n \"registeredAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"US\",\n \"postalCode\" : \"10003\",\n \"stateOrProvince\" : \"NY\",\n \"street\" : \"71 5th Avenue\",\n \"street2\" : \"11th floor\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a legal entity for a trust in Australia", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"trust\",\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678123\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"trust\" : {\n \"countryOfGoverningLaw\" : \"AU\",\n \"doingBusinessAs\" : \"West's Store\",\n \"name\" : \"Example Trust\",\n \"registeredAddress\" : {\n \"city\" : \"Sydney\",\n \"country\" : \"AU\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"street\" : \"Winfield Avenue\"\n },\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"number\" : \"12345678901\",\n \"type\" : \"ABN\"\n } ],\n \"type\" : \"fixedUnitTrust\",\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\",\n \"reference\" : \"SE322KH223222J5HJ6JRB75HQ\"\n } ]\n },\n \"type\" : \"trust\",\n \"id\" : \"LE322KH223222J5HJ6JRB75C5\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"trust\",\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678123\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"trust\",\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678123\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] } ] - } -, + }, { "name": "/legalEntities/:id", "description": "Returns a legal entity.", @@ -369,49 +781,50 @@ { "name": "Get a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "description": "Returns a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns a legal entity." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -419,281 +832,605 @@ { "name": "Change a legal entity from an organization to an individual", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"individual\" : {\n \"name\" : {\n \"firstName\" : \"Explorer\",\n \"lastName\" : \"Company based in US\"\n },\n \"residentialAddress\" : {\n \"country\" : \"US\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"individual\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"individual\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Add entity associations to an organization", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000001\",\n \"entityType\" : \"individual\",\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"name\" : \"Simone Hopper\",\n \"type\" : \"uboThroughControl\"\n } ],\n \"organization\" : {\n \"email\" : \"john.doe@adyen.com\",\n \"phone\" : {\n \"countryCode\" : \"NL\",\n \"number\" : \"646467363\",\n \"type\" : \"mobile\"\n },\n \"description\" : \"FinTech\",\n \"doingBusinessAs\" : \"Adyen BV\",\n \"legalName\" : \"Adyen BV\",\n \"registeredAddress\" : {\n \"city\" : \"AMS\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1234EE\",\n \"stateOrProvince\" : \"NH\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n },\n \"registrationNumber\" : \"\",\n \"stockData\" : {\n \"marketIdentifier\" : \"ADYN\",\n \"stockNumber\" : \"NL012345ABC4\",\n \"tickerSymbol\" : \"ADYN.M\"\n },\n \"type\" : \"listedPublicCompany\"\n },\n \"type\" : \"organization\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"jobTitle\" : \"CEO\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"uboThroughControl\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Add entity associations to a sole proprietorship", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"soleProprietorship\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000001\",\n \"entityType\" : \"soleProprietorship\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"soleProprietorship\"\n } ],\n \"individual\" : {\n \"email\" : \"s.eller@example.com\",\n \"birthData\" : {\n \"dateOfBirth\" : \"1990-06-21\"\n },\n \"name\" : {\n \"firstName\" : \"Shelly\",\n \"lastName\" : \"Eller\"\n },\n \"residentialAddress\" : {\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\",\n \"postalCode\" : \"1011DJ\",\n \"street\" : \"Simon Carmiggeltstraat 6 - 50\"\n }\n },\n \"type\" : \"individual\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"soleProprietorship\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"soleProprietorship\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Associate a trust member with a trust", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"protector\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000001\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"name\" : \"Simone Hopper\",\n \"type\" : \"protector\"\n } ],\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678901\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n },\n \"type\" : \"trust\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"protector\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"protector\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] }, { "name": "Associate an exempt settlor with a trust", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"settlor\",\n \"entityType\" : \"individual\",\n \"settlorExemptionReason\" : [ \"deceased\", \"professionalServiceProvider\" ]\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"entityAssociations\" : [ {\n \"associatorId\" : \"LE00000000000000000000001\",\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"settlor\",\n \"entityType\" : \"individual\",\n \"settlorExemptionReason\" : [ \"deceased\", \"professionalServiceProvider\" ]\n } ],\n \"trust\" : {\n \"name\" : \"Example Trust\",\n \"type\" : \"fixedUnitTrust\",\n \"doingBusinessAs\" : \"West's Store\",\n \"countryOfGoverningLaw\" : \"AU\",\n \"taxInformation\" : [ {\n \"country\" : \"AU\",\n \"type\" : \"ABN\",\n \"number\" : \"12345678901\"\n } ],\n \"registeredAddress\" : {\n \"street\" : \"Winfield Avenue\",\n \"city\" : \"Sydney\",\n \"postalCode\" : \"1197\",\n \"stateOrProvince\" : \"NSW\",\n \"country\" : \"AU\"\n },\n \"undefinedBeneficiaryInfo\" : [ {\n \"description\" : \"My future children\"\n } ]\n },\n \"type\" : \"trust\",\n \"id\" : \"LE00000000000000000000001\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"settlor\",\n \"entityType\" : \"individual\",\n \"settlorExemptionReason\" : [ \"deceased\", \"professionalServiceProvider\" ]\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"entityAssociations\" : [ {\n \"legalEntityId\" : \"LE00000000000000000000002\",\n \"type\" : \"settlor\",\n \"entityType\" : \"individual\",\n \"settlorExemptionReason\" : [ \"deceased\", \"professionalServiceProvider\" ]\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/businessLines", "description": "Returns the business lines owned by a legal entity.", @@ -701,50 +1438,51 @@ { "name": "Get all business lines under a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/businessLines", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "businessLines" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "description": "Returns the business lines owned by a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "businessLines" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the business lines owned by a legal entity." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/legalEntities/:id/checkVerificationErrors", "description": "Returns the verification errors for a legal entity and its supporting entities.", @@ -752,50 +1490,51 @@ { "name": "Check a legal entity's verification errors", "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/checkVerificationErrors", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "checkVerificationErrors" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity." - } - ], - "query": [ - ] - }, - "description": "Returns the verification errors for a legal entity and its supporting entities." - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/checkVerificationErrors", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "checkVerificationErrors" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the verification errors for a legal entity and its supporting entities." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -803,50 +1542,51 @@ { "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." - } + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -854,155 +1594,216 @@ "item": [ { "name": "/legalEntities/:id/onboardingLinks", - "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. ", "item": [ { "name": "Create a hosted onboarding link", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"themeId\" : \"YOUR_THEME_ID\",\n \"redirectUrl\" : \"https://your.redirect-url.com/\",\n \"locale\" : \"nl-NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "onboardingLinks" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity" + } + ], + "query": [ + ] + }, + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"url\" : \"https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"themeId\" : \"YOUR_THEME_ID\",\n \"redirectUrl\" : \"https://your.redirect-url.com/\",\n \"locale\" : \"nl-NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "onboardingLinks" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity" + } + ], + "query": [ + ] + }, + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"themeId\" : \"YOUR_THEME_ID\",\n \"redirectUrl\" : \"https://your.redirect-url.com/\",\n \"locale\" : \"nl-NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "onboardingLinks" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity" - } - ], - "query": [ - ] - }, - "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] } ] - } -, + }, { "name": "/themes", - "description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Returns a list of hosted onboarding page themes. ", "item": [ { "name": "Get a list of hosted onboarding page themes", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/themes", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "themes" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of hosted onboarding page themes. " +} + ,"response": [ + ] } ] - } -, + }, { "name": "/themes/:id", - "description": "Returns the details of the theme identified in the path.>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Returns the details of the theme identified in the path.", "item": [ { "name": "Get an onboarding link theme", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/themes/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "themes", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the theme" - } - ], - "query": [ - ] - }, - "description": "Returns the details of the theme identified in the path.>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the theme" + } + ], + "query": [ + ] + }, + "description": "Returns the details of the theme identified in the path." +} + ,"response": [ + ] } ] } - ] }, { @@ -1010,97 +1811,202 @@ "item": [ { "name": "/businessLines", - "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. ", "item": [ { "name": "Create a business line for a business account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"service\" : \"banking\",\n \"industryCode\" : \"4531\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"type\" : \"business\",\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"industryCode\" : \"4531\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"service\" : \"banking\",\n \"sourceOfFunds\" : {\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\",\n \"type\" : \"business\"\n },\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\",\n \"webAddressId\" : \"SE322JV223222F5H4CQGS77V4\"\n } ],\n \"id\" : \"SE322KT223222D5FJ7TJN2986\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"service\" : \"banking\",\n \"industryCode\" : \"4531\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"type\" : \"business\",\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"service\" : \"banking\",\n \"industryCode\" : \"4531\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.adyen.com\"\n } ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"type\" : \"business\",\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] }, { "name": "Create a business line for receiving payments", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"service\" : \"paymentProcessing\",\n \"industryCode\" : \"339E\",\n \"salesChannels\" : [ \"eCommerce\", \"ecomMoto\" ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"webData\" : [ {\n \"webAddress\" : \"https://yoururl.com\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"service\" : \"paymentProcessing\",\n \"industryCode\" : \"339E\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"salesChannels\" : [ \"eCommerce\", \"ecomMoto\" ],\n \"webData\" : [ {\n \"webAddress\" : \"https://yoururl.com\",\n \"webAddressId\" : \"SE654AC923222F5H4CQGS77V4\"\n } ],\n \"id\" : \"SE322KT223222D5FJ7TJN2986\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"service\" : \"paymentProcessing\",\n \"industryCode\" : \"339E\",\n \"salesChannels\" : [ \"eCommerce\", \"ecomMoto\" ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"webData\" : [ {\n \"webAddress\" : \"https://yoururl.com\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"service\" : \"paymentProcessing\",\n \"industryCode\" : \"339E\",\n \"salesChannels\" : [ \"eCommerce\", \"ecomMoto\" ],\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"webData\" : [ {\n \"webAddress\" : \"https://yoururl.com\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " - } + ] } ] - } -, + }, { "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.", @@ -1108,49 +2014,50 @@ { "name": "Delete a business line", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the business line to be deleted." - } - ], - "query": [ - ] - }, - "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." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line to be deleted." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/businessLines/:id", "description": "Returns the detail of a business line.", @@ -1158,49 +2065,50 @@ { "name": "Get a business line", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the business line." - } - ], - "query": [ - ] - }, - "description": "Returns the detail of a business line." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Returns the detail of a business line." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/businessLines/:id", "description": "Updates a business line.", @@ -1208,55 +2116,113 @@ { "name": "Update a business line", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"industryCode\" : \"55\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.example.com\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Updates a business line." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"service\" : \"banking\",\n \"industryCode\" : \"55\",\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"sourceOfFunds\" : {\n \"adyenProcessedFunds\" : false,\n \"description\" : \"Funds from my flower shop business\",\n \"type\" : \"business\"\n },\n \"webData\" : [ {\n \"webAddress\" : \"https://www.example.com\",\n \"webAddressId\" : \"SE966LI345672J5H8V87B3FGH\"\n } ],\n \"id\" : \"SE322JV223222F5GVGMLNB83F\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"industryCode\" : \"55\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.example.com\"\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Updates a business line." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"industryCode\" : \"55\",\n \"webData\" : [ {\n \"webAddress\" : \"https://www.example.com\"\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/businessLines/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "businessLines", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the business line." - } - ], - "query": [ - ] - }, - "description": "Updates a business line." - } + ] } ] } - ] }, { @@ -1269,55 +2235,113 @@ { "name": "Upload a document", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"fileName\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n },\n \"id\" : \"SE322JV223222F5GV2N9L8GDK\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"registrationDocument\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Registration doc for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs." - } + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Deletes a document.", @@ -1325,49 +2349,50 @@ { "name": "Delete a document", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document to be deleted." - } - ], - "query": [ - ] - }, - "description": "Deletes a document." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a document." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Returns a document.", @@ -1375,55 +2400,56 @@ { "name": "Get a document", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document." - } - ], - "query": [ - { - "key": "skipContent", - "value": "true", - "description": "Do not load document content while fetching the document.", - "disabled": true - } - ] - }, - "description": "Returns a document." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document." + } + ], + "query": [ + { + "key": "skipContent", + "value": "true", + "description": "Do not load document content while fetching the document.", + "disabled": true + } + ] + }, + "description": "Returns a document." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/documents/:id", "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs.", @@ -1431,61 +2457,125 @@ { "name": "Update a document", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be updated." + } + ], + "query": [ + ] + }, + "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"proofOfIndustry\",\n \"attachments\" : [ {\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n } ],\n \"description\" : \"Proof of industry for Example Company\",\n \"fileName\" : \"Proof of industry for Example Company\",\n \"owner\" : {\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"legalEntity\"\n },\n \"id\" : \"SE322JV223222F5GV2N9L8GDK\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be updated." + } + ], + "query": [ + ] + }, + "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"proofOfIndustry\",\n \"description\" : \"Proof of industry doc for Example Company\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/documents/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "documents", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the document to be updated." - } - ], - "query": [ - ] - }, - "description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs." - } + ] } ] } - ] }, { @@ -1498,56 +2588,115 @@ { "name": "Get the Terms of Service document", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns the Terms of Service document for a legal entity." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"LE00000000000000000000001\",\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\",\n \"document\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"termsOfServiceDocumentId\" : \"abc123\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns the Terms of Service document for a legal entity." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"adyenIssuing\",\n \"language\" : \"en\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfService", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfService" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - } - ], - "query": [ - ] - }, - "description": "Returns the Terms of Service document for a legal entity." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/termsOfService/:termsofservicedocumentid", "description": "Accepts Terms of Service.", @@ -1555,62 +2704,127 @@ { "name": "Accept the Terms of Service document", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"acceptedBy\" : \"LE00000000000000000000002\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService", + ":termsofservicedocumentid" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + }, + { + "key": "termsofservicedocumentid", + "value": "", + "description": "The unique identifier of the Terms of Service document." + } + ], + "query": [ + ] + }, + "description": "Accepts Terms of Service." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"acceptedBy\" : \"LE00000000000000000000002\",\n \"id\" : \"TOSA000AB00000000B2AAAB2BA0AA0\",\n \"language\" : \"en\",\n \"termsOfServiceDocumentId\" : \"abc123\",\n \"type\" : \"adyenIssuing\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"acceptedBy\" : \"LE00000000000000000000002\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfService", + ":termsofservicedocumentid" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + }, + { + "key": "termsofservicedocumentid", + "value": "", + "description": "The unique identifier of the Terms of Service document." + } + ], + "query": [ + ] + }, + "description": "Accepts Terms of Service." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"acceptedBy\" : \"LE00000000000000000000002\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfService", - ":termsofservicedocumentid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - }, - { - "key": "termsofservicedocumentid", - "value": "", - "description": "The unique identifier of the Terms of Service document." - } - ], - "query": [ - ] - }, - "description": "Accepts Terms of Service." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/termsOfServiceAcceptanceInfos", "description": "Returns Terms of Service information for a legal entity.", @@ -1618,50 +2832,51 @@ { "name": "Get Terms of Service information for a legal entity", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceAcceptanceInfos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfServiceAcceptanceInfos" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - } - ], - "query": [ - ] - }, - "description": "Returns Terms of Service information for a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceAcceptanceInfos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfServiceAcceptanceInfos" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns Terms of Service information for a legal entity." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/legalEntities/:id/termsOfServiceStatus", "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity.", @@ -1669,50 +2884,51 @@ { "name": "Get Terms of Service status", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceStatus", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "termsOfServiceStatus" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." - } - ], - "query": [ - ] - }, - "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceStatus", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "termsOfServiceStatus" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner." + } + ], + "query": [ + ] + }, + "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity." +} + ,"response": [ + ] } ] } - ] }, { @@ -1725,104 +2941,221 @@ { "name": "Add a EUR bank account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL62ABNA0000000123\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL62ABNA0000000123\"\n },\n \"countryCode\" : \"NL\",\n \"trustedSource\" : false\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"capabilities\" : {\n \"sendToTransferInstrument\" : {\n \"allowed\" : false,\n \"requested\" : true,\n \"verificationStatus\" : \"pending\"\n }\n },\n \"id\" : \"SE322KH223222F5GXZFNM3BGP\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL62ABNA0000000123\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL62ABNA0000000123\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." - } + ] }, { "name": "Add a USD bank account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"0000000123\",\n \"routingNumber\" : \"121202211\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"0000000123\",\n \"accountType\" : \"checking\",\n \"routingNumber\" : \"121202211\"\n },\n \"countryCode\" : \"US\",\n \"trustedSource\" : false\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"capabilities\" : {\n \"sendToTransferInstrument\" : {\n \"allowed\" : false,\n \"requested\" : true,\n \"verificationStatus\" : \"pending\"\n }\n },\n \"id\" : \"SE322JV223222F5GJVKHH8DTC\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"0000000123\",\n \"routingNumber\" : \"121202211\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"0000000123\",\n \"routingNumber\" : \"121202211\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." - } + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Deletes a transfer instrument.", @@ -1830,49 +3163,50 @@ { "name": "Delete a transfer instrument", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument to be deleted." - } - ], - "query": [ - ] - }, - "description": "Deletes a transfer instrument." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a transfer instrument." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Returns the details of a transfer instrument.", @@ -1880,49 +3214,50 @@ { "name": "Get a transfer instrument", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a transfer instrument." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a transfer instrument." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/transferInstruments/:id", "description": "Updates a transfer instrument.", @@ -1930,61 +3265,125 @@ { "name": "Update a transfer instrument", "request": { - "method": "PATCH", - "header": [ - { - "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 + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL02ABNA0123456789\"\n }\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a transfer instrument." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL02ABNA0123456789\"\n },\n \"countryCode\" : \"NL\"\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\",\n \"id\" : \"SE322KH223222F5GXZFNM3BGP\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL02ABNA0123456789\"\n }\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a transfer instrument." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bankAccount\" : {\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL02ABNA0123456789\"\n }\n },\n \"legalEntityId\" : \"LE00000000000000000000001\",\n \"type\" : \"bankAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transferInstruments/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transferInstruments", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transfer instrument." - } - ], - "query": [ - ] - }, - "description": "Updates a transfer instrument." - } + ] } ] } - ] }, { @@ -1997,50 +3396,51 @@ { "name": "Get PCI questionnaire details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity to get PCI questionnaire information." - } - ], - "query": [ - ] - }, - "description": "Get a list of signed PCI questionnaires." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity to get PCI questionnaire information." + } + ], + "query": [ + ] + }, + "description": "Get a list of signed PCI questionnaires." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/legalEntities/:id/pciQuestionnaires/:pciid", "description": "Returns the signed PCI questionnaire.", @@ -2048,56 +3448,57 @@ { "name": "Get PCI questionnaire", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/:pciid", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires", - ":pciid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The legal entity ID of the individual who signed the PCI questionnaire." - }, - { - "key": "pciid", - "value": "", - "description": "The unique identifier of the signed PCI questionnaire." - } - ], - "query": [ - ] - }, - "description": "Returns the signed PCI questionnaire." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/:pciid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + ":pciid" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The legal entity ID of the individual who signed the PCI questionnaire." + }, + { + "key": "pciid", + "value": "", + "description": "The unique identifier of the signed PCI questionnaire." + } + ], + "query": [ + ] + }, + "description": "Returns the signed PCI questionnaire." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -2105,57 +3506,117 @@ { "name": "Generate PCI questionnaires", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"language\" : \"fr\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "generatePciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity to get PCI questionnaire information." + } + ], + "query": [ + ] + }, + "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"content\" : \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"language\" : \"fr\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"language\" : \"fr\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "generatePciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity to get PCI questionnaire information." + } + ], + "query": [ + ] + }, + "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"language\" : \"fr\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires", - "generatePciTemplates" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the legal entity to get PCI questionnaire information." - } - ], - "query": [ - ] - }, - "description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)." - } + ] } ] - } -, + }, { "name": "/legalEntities/:id/pciQuestionnaires/signPciTemplates", "description": "Signs the required PCI questionnaire.", @@ -2163,57 +3624,117 @@ { "name": "Sign PCI questionnaires", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"signedBy\" : \"LE00000000000000000000002\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "signPciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The legal entity ID of the user that has a contractual relationship with your platform." + } + ], + "query": [ + ] + }, + "description": "Signs the required PCI questionnaire." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pciQuestionnaireIds\" : [ \"PCID422GZ22322565HHMH48CW63CPH\", \"PCID422GZ22322565HHMH49CW75Z9H\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"signedBy\" : \"LE00000000000000000000002\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + ":id", + "pciQuestionnaires", + "signPciTemplates" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The legal entity ID of the user that has a contractual relationship with your platform." + } + ], + "query": [ + ] + }, + "description": "Signs the required PCI questionnaire." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"signedBy\" : \"LE00000000000000000000002\",\n \"pciTemplateReferences\" : [ \"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legalEntities", - ":id", - "pciQuestionnaires", - "signPciTemplates" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The legal entity ID of the user that has a contractual relationship with your platform." - } - ], - "query": [ - ] - }, - "description": "Signs the required PCI questionnaire." - } + ] } ] } - ] } ], diff --git a/postman/ManagementService-v1.json b/postman/ManagementService-v1.json index caa9340..5c5d1c1 100644 --- a/postman/ManagementService-v1.json +++ b/postman/ManagementService-v1.json @@ -19,57 +19,58 @@ { "name": "Generate new API key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "generateApiKey" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "generateApiKey" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" +} + ,"response": [ + ] } ] } - ] }, { @@ -82,55 +83,56 @@ { "name": "Get a list of merchant accounts", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants" - ], - "variable": [ - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the list of 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants" + ], + "variable": [ + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the list of 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -138,49 +140,101 @@ { "name": "Create a merchant account for an Adyen for Platforms Manage integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyId\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"legalEntityId\" : \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\" : \"YOUR_BUSINESS_LINE_ID\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"reference\" : \"YOUR_OWN_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"companyId\" : \"YOUR_COMPANY_ACCOUNT\",\n \"legalEntityId\" : \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\" : \"YOUR_BUSINESS_LINE_ID\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"reference\" : \"YOUR_OWN_REFERENCE\",\n \"id\" : \"YOUR_OWN_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyId\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"legalEntityId\" : \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\" : \"YOUR_BUSINESS_LINE_ID\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"reference\" : \"YOUR_OWN_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyId\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"legalEntityId\" : \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\" : \"YOUR_BUSINESS_LINE_ID\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"reference\" : \"YOUR_OWN_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants" - ], - "variable": [ - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -188,49 +242,50 @@ { "name": "Get a merchant account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -238,50 +293,51 @@ { "name": "Request to activate a merchant account", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/activate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "activate" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/activate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "activate" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -294,50 +350,51 @@ { "name": "Get a list of split configurations", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "description": "Returns the list of split configurations for the merchant account. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Returns the list of split configurations for the merchant account. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -345,56 +402,115 @@ { "name": "Create a split configuration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"paymentMethod\" : \"ANY\",\n \"shopperInteraction\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"ANY\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"paymentMethod\" : \"ANY\",\n \"shopperInteraction\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"ANY\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"paymentMethod\" : \"ANY\",\n \"shopperInteraction\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"ANY\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -402,56 +518,57 @@ { "name": "Delete a split configuration", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -459,56 +576,57 @@ { "name": "Get a split configuration", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -516,62 +634,127 @@ { "name": "Update split configuration description", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Updated description for the split configuration\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Updated description for the split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n }, {\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"ruleId\" : \"SCRL4224P22322585HPCX5V4KV6L2R\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX5V4KW26C9\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Updated description for the split configuration\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Updated description for the split configuration\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -579,62 +762,127 @@ { "name": "Add rule to a split configuration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"POS\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"USD\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"My first split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n }, {\n \"currency\" : \"USD\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"ruleId\" : \"SCRL4224P22322585HPCX5V4KV6L2R\",\n \"shopperInteraction\" : \"POS\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX5V4KW26C9\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"POS\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"USD\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"POS\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"USD\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -642,63 +890,64 @@ { "name": "Delete a split configuration rule", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId", - "rules", - ":ruleId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - }, - { - "key": "ruleId", - "value": "", - "description": "" - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "" + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -706,69 +955,141 @@ { "name": "Update the conditions in split configuration rule", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"ANY\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "The unique identifier of the split configuration rule." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n }, {\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"ruleId\" : \"SCRL4224P22322585HPCX5V4KV6L2R\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX5V4KW26C9\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"ANY\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "The unique identifier of the split configuration rule." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"ANY\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId", - "rules", - ":ruleId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The identifier of the split configuration." - }, - { - "key": "ruleId", - "value": "", - "description": "The unique identifier of the split configuration rule." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -776,76 +1097,155 @@ { "name": "Update the split logic", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId", + "splitLogic", + ":splitLogicId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "The unique identifier of the split configuration rule." + }, + { + "key": "splitLogicId", + "value": "", + "description": "The unique identifier of the split configuration split." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n }, {\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"ruleId\" : \"SCRL4224P22322585HPCX5V4KV6L2R\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX5V4KW26C9\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId", + "splitLogic", + ":splitLogicId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "The unique identifier of the split configuration rule." + }, + { + "key": "splitLogicId", + "value": "", + "description": "The unique identifier of the split configuration split." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId", - "rules", - ":ruleId", - "splitLogic", - ":splitLogicId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - }, - { - "key": "ruleId", - "value": "", - "description": "The unique identifier of the split configuration rule." - }, - { - "key": "splitLogicId", - "value": "", - "description": "The unique identifier of the split configuration split." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -858,57 +1258,58 @@ { "name": "Get a list of allowed origins", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -916,63 +1317,129 @@ { "name": "Add an allowed origin for the API credential", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_ALLOWED_ORIGIN\",\n \"domain\" : \"https://www.eu.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -980,63 +1447,64 @@ { "name": "Delete an allowed origin", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - }, - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -1044,63 +1512,64 @@ { "name": "Get an allowed origin", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - }, - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -1113,57 +1582,58 @@ { "name": "Generate new API key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "generateApiKey" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "generateApiKey" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" +} + ,"response": [ + ] } ] } - ] }, { @@ -1176,57 +1646,58 @@ { "name": "Generate new client key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "generateClientKey" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "generateClientKey" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" +} + ,"response": [ + ] } ] } - ] }, { @@ -1239,68 +1710,69 @@ { "name": "Get a list of users", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "users" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to return.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The partial or complete username to select all users that match.", - "disabled": true - } - ] - }, - "description": "Returns the list of users 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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to return.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The partial or complete username to select all users that match.", + "disabled": true + } + ] + }, + "description": "Returns the list of users 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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -1308,56 +1780,115 @@ { "name": "Create a user", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\", \"Merchant admin\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-5C334C6770\",\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"username\" : \"johnsmith\",\n \"roles\" : [ \"Merchant standard role\", \"Merchant admin\" ],\n \"active\" : true,\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users/S2-5C334C6770\"\n }\n },\n \"associatedMerchantAccounts\" : [ \"YOUR_MERCHANT_ACCOUNT\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\", \"Merchant admin\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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 " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\", \"Merchant admin\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "users" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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 " - } + ] } ] - } -, + }, { "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 ", @@ -1365,56 +1896,57 @@ { "name": "Get user details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/users/:userId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "users", - ":userId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "userId", - "value": "", - "description": "The unique identifier of the user." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users", + ":userId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "userId", + "value": "", + "description": "The unique identifier of the user." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -1422,62 +1954,63 @@ { "name": "Update user details", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"associatedMerchantAccounts\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/users/:userId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "users", - ":userId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "userId", - "value": "", - "description": "The unique identifier of the user." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"associatedMerchantAccounts\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users", + ":userId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "userId", + "value": "", + "description": "The unique identifier of the user." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] } - ] }, { @@ -1490,138 +2023,299 @@ { "name": "Schedule installing an Android app", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF732K8\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"actionDetails\" : {\n \"appId\" : \"ANDA422LZ223223K5F694GCCF732K8\",\n \"type\" : \"InstallAndroidApp\"\n },\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"storeId\" : \"\",\n \"items\" : [ {\n \"id\" : \"TRAC422T2223223K5GFMQHM6WQ4KB6\",\n \"terminalId\" : \"S1E-000150183300032\"\n }, {\n \"id\" : \"TRAC4224X22338VQ5GD4CQJCQT5PC2\",\n \"terminalId\" : \"S1E-000150183300033\"\n }, {\n \"id\" : \"TRAC4224Z223223K5GD89RLBWQ6CWT\",\n \"terminalId\" : \"S1F2-000150183300034\"\n } ],\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"terminalsWithErrors\" : { },\n \"totalScheduled\" : 3,\n \"totalErrors\" : 0\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF732K8\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF732K8\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/scheduleActions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - "scheduleActions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" - } + ] }, { "name": "Schedule uninstalling an Android certificate", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"UninstallAndroidCertificate\",\n \"certificateId\" : \"ANDC422LZ223223K5F78NVN9SL4VPH\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"actionDetails\" : {\n \"certificateId\" : \"ANDC422LZ223223K5F78NVN9SL4VPH\",\n \"type\" : \"UninstallAndroidCertificate\"\n },\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"storeId\" : \"\",\n \"items\" : [ {\n \"id\" : \"TRAC422T2223223K5GFMQHM6WQ4KB6\",\n \"terminalId\" : \"S1E-000150183300032\"\n }, {\n \"id\" : \"TRAC4224X22338VQ5GD4CQJCQT5PC2\",\n \"terminalId\" : \"S1E-000150183300033\"\n }, {\n \"id\" : \"TRAC4224Z223223K5GD89RLBWQ6CWT\",\n \"terminalId\" : \"S1F2-000150183300034\"\n } ],\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"terminalsWithErrors\" : { },\n \"totalScheduled\" : 3,\n \"totalErrors\" : 0\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"UninstallAndroidCertificate\",\n \"certificateId\" : \"ANDC422LZ223223K5F78NVN9SL4VPH\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"UninstallAndroidCertificate\",\n \"certificateId\" : \"ANDC422LZ223223K5F78NVN9SL4VPH\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/scheduleActions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - "scheduleActions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" - } + ] }, { "name": "Invalid terminal ID in the request", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-11T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF621J7\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} + ,"response": [ + {"name": "Unprocessable Entity - a request validation error.", + "code": 422, + "status": "Unprocessable Entity", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"https://docs.adyen.com/errors/unprocessable-entity\",\n \"errorCode\" : \"02_005\",\n \"title\" : \"Terminal ID verification failed.\",\n \"status\" : 422,\n \"detail\" : \"Terminal IDs are empty\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-11T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF621J7\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-11T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF621J7\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/scheduleActions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - "scheduleActions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" - } + ] } ] } - ] }, { @@ -1634,50 +2328,51 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalLogos" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "description": "Returns the logo that is configured for the payment terminal 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. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "description": "Returns the logo that is configured for the payment terminal 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. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -1685,106 +2380,225 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalLogos" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalLogos" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -1792,50 +2606,51 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalSettings" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -1843,106 +2658,225 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"notification\" : {\n \"showButton\" : true\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75,\n \"restartHour\" : 5\n },\n \"passcodes\" : {\n \"adminMenuPin\" : \"1234\",\n \"txMenuPin\" : \"1234\",\n \"refundPin\" : \"123456\",\n \"screenLockPin\" : \"1111\"\n },\n \"connectivity\" : {\n \"simcardStatus\" : \"INVENTORY\"\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalSettings" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"notification\" : {\n \"showButton\" : true\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75,\n \"restartHour\" : 5\n },\n \"passcodes\" : {\n \"adminMenuPin\" : \"1234\",\n \"txMenuPin\" : \"1234\",\n \"refundPin\" : \"123456\",\n \"screenLockPin\" : \"1111\"\n },\n \"connectivity\" : {\n \"simcardStatus\" : \"INVENTORY\"\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalSettings" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -1955,50 +2889,51 @@ { "name": "Get a list of payout settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "description": "Returns the list of payout settings for the merchant account 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Returns the list of payout settings for the merchant account 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2006,56 +2941,57 @@ { "name": "Add a payout setting", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"enabled\": \"\",\n \"enabledFromDate\": \"\",\n \"transferInstrumentId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"enabledFromDate\": \"\",\n \"transferInstrumentId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2063,56 +2999,57 @@ { "name": "Delete a payout setting", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings", - ":payoutSettingsId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "payoutSettingsId", - "value": "", - "description": "The unique identifier of the payout setting." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings", + ":payoutSettingsId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "payoutSettingsId", + "value": "", + "description": "The unique identifier of the payout setting." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2120,56 +3057,57 @@ { "name": "Get a payout setting", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings", - ":payoutSettingsId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "payoutSettingsId", - "value": "", - "description": "The unique identifier of the payout setting." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings", + ":payoutSettingsId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "payoutSettingsId", + "value": "", + "description": "The unique identifier of the payout setting." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2177,62 +3115,63 @@ { "name": "Update a payout setting", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"enabled\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings", - ":payoutSettingsId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "payoutSettingsId", - "value": "", - "description": "The unique identifier of the payout setting." - } - ], - "query": [ - ] - }, - "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" - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings", + ":payoutSettingsId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "payoutSettingsId", + "value": "", + "description": "The unique identifier of the payout setting." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -2245,62 +3184,63 @@ { "name": "List all webhooks", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Lists all webhook configurations for the merchant account. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Lists all webhook configurations for the merchant account. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2308,56 +3248,115 @@ { "name": "Add a webhook configuration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-31433949437F\",\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"description\" : \"Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE\",\n \"username\" : \"myuser\",\n \"hasPassword\" : true,\n \"active\" : true,\n \"hasError\" : false,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"certificateAlias\" : \"signed-test.adyen.com_2023\",\n \"populateSoapActionHeader\" : false,\n \"additionalSettings\" : {\n \"properties\" : {\n \"includePosTerminalInfo\" : false,\n \"includeARN\" : false,\n \"includePosDetails\" : false,\n \"includeCardInfoForRecurringContractNotification\" : false,\n \"includeRiskData\" : false,\n \"includeRiskExperimentReference\" : false,\n \"includeSoapSecurityHeader\" : false,\n \"includeContactlessWalletTokenInformation\" : false,\n \"includeAcquirerReference\" : false,\n \"includeRiskProfileReference\" : false,\n \"includeOriginalMerchantReferenceCancelOrRefundNotification\" : false,\n \"includeNfcTokenInformation\" : false,\n \"includeSubvariant\" : false,\n \"includeThreeDSVersion\" : false,\n \"includeInstallmentsInfo\" : false,\n \"includeAliasInfo\" : false,\n \"includeShopperCountry\" : false,\n \"includeRawThreeDSecureResult\" : false,\n \"includeAirlineData\" : false,\n \"includeGrossCurrencyChargebackDetails\" : false,\n \"includeThreeDSecureResult\" : false,\n \"includeMetadataIn3DSecurePaymentNotification\" : false,\n \"includeOriginalReferenceForChargebackReversed\" : false,\n \"addAcquirerResult\" : false,\n \"includeDeliveryAddress\" : false,\n \"includeRetryAttempts\" : false,\n \"includeExtraCosts\" : false,\n \"includeCardHolderName\" : false,\n \"includeShopperDetail\" : false,\n \"includeBankAccountDetails\" : false,\n \"includeMandateDetails\" : false,\n \"includeAuthAmountForDynamicZeroAuth\" : false,\n \"includeIssuerCountry\" : false,\n \"includeAcquirerErrorDetails\" : false,\n \"includeCoBrandedWith\" : false,\n \"includeShopperInteraction\" : false,\n \"includeDeviceAndBrowserInfo\" : false,\n \"addRawAcquirerResult\" : false,\n \"includeCardBin\" : false,\n \"includeFundingSource\" : false,\n \"includeThreeDS2ChallengeInformation\" : false,\n \"includeRiskProfile\" : false,\n \"includeRealtimeAccountUpdaterStatus\" : false,\n \"includeDunningProjectData\" : false,\n \"includePaymentResultInOrderClosedNotification\" : false,\n \"includeCardBinDetails\" : false,\n \"includeNotesInManualReviewNotifications\" : false,\n \"includeZeroAuthFlag\" : false,\n \"addCaptureReferenceToDisputeNotification\" : false,\n \"includePayPalDetails\" : false,\n \"includeRawThreeDSecureDetailsResult\" : false,\n \"includeBankVerificationResults\" : false,\n \"includeCaptureDelayHours\" : false,\n \"addPaymentAccountReference\" : false,\n \"includePayULatamDetails\" : false,\n \"includeStore\" : false,\n \"returnAvsData\" : false,\n \"includeWeChatPayOpenid\" : false,\n \"includeUpiVpa\" : false,\n \"includeCustomRoutingFlagging\" : false,\n \"includeTokenisedPaymentMetaData\" : false\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F\"\n },\n \"generateHmac\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F/generateHmac\"\n },\n \"merchant\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT\"\n },\n \"testWebhook\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F/test\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -2365,56 +3364,57 @@ { "name": "Remove a webhook", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2422,56 +3422,57 @@ { "name": "Get a webhook", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2479,62 +3480,127 @@ { "name": "Activate the webhook", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-3E5E42476641\",\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"description\" : \"Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE\",\n \"username\" : \"\",\n \"hasPassword\" : false,\n \"active\" : true,\n \"hasError\" : false,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : false,\n \"acceptsUntrustedRootCertificate\" : false,\n \"populateSoapActionHeader\" : false,\n \"additionalSettings\" : {\n \"properties\" : {\n \"includePosTerminalInfo\" : false,\n \"includeARN\" : false,\n \"includePosDetails\" : false,\n \"includeCardInfoForRecurringContractNotification\" : false,\n \"includeRiskData\" : false,\n \"includeRiskExperimentReference\" : false,\n \"includeSoapSecurityHeader\" : false,\n \"includeContactlessWalletTokenInformation\" : false,\n \"includeAcquirerReference\" : false,\n \"includeRiskProfileReference\" : false,\n \"includeOriginalMerchantReferenceCancelOrRefundNotification\" : false,\n \"includeNfcTokenInformation\" : false,\n \"includeSubvariant\" : false,\n \"includeThreeDSVersion\" : false,\n \"includeInstallmentsInfo\" : false,\n \"includeAliasInfo\" : false,\n \"includeShopperCountry\" : false,\n \"includeRawThreeDSecureResult\" : false,\n \"includeAirlineData\" : false,\n \"includeGrossCurrencyChargebackDetails\" : false,\n \"includeThreeDSecureResult\" : false,\n \"includeMetadataIn3DSecurePaymentNotification\" : false,\n \"includeOriginalReferenceForChargebackReversed\" : false,\n \"addAcquirerResult\" : false,\n \"includeDeliveryAddress\" : false,\n \"includeRetryAttempts\" : false,\n \"includeExtraCosts\" : false,\n \"includeCardHolderName\" : false,\n \"includeShopperDetail\" : false,\n \"includeBankAccountDetails\" : false,\n \"includeMandateDetails\" : false,\n \"includeAuthAmountForDynamicZeroAuth\" : false,\n \"includeIssuerCountry\" : false,\n \"includeAcquirerErrorDetails\" : false,\n \"includeCoBrandedWith\" : false,\n \"includeShopperInteraction\" : false,\n \"includeDeviceAndBrowserInfo\" : false,\n \"addRawAcquirerResult\" : false,\n \"includeCardBin\" : false,\n \"includeFundingSource\" : false,\n \"includeThreeDS2ChallengeInformation\" : false,\n \"includeRiskProfile\" : false,\n \"includeRealtimeAccountUpdaterStatus\" : false,\n \"includeDunningProjectData\" : false,\n \"includePaymentResultInOrderClosedNotification\" : false,\n \"includeCardBinDetails\" : false,\n \"includeNotesInManualReviewNotifications\" : false,\n \"includeZeroAuthFlag\" : false,\n \"addCaptureReferenceToDisputeNotification\" : false,\n \"includePayPalDetails\" : false,\n \"includeRawThreeDSecureDetailsResult\" : false,\n \"includeBankVerificationResults\" : false,\n \"includeCaptureDelayHours\" : false,\n \"addPaymentAccountReference\" : false,\n \"includePayULatamDetails\" : false,\n \"includeStore\" : false,\n \"returnAvsData\" : false,\n \"includeWeChatPayOpenid\" : false,\n \"includeUpiVpa\" : false,\n \"includeCustomRoutingFlagging\" : false,\n \"includeTokenisedPaymentMetaData\" : false\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641\"\n },\n \"generateHmac\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/generateHmac\"\n },\n \"merchant\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT\"\n },\n \"testWebhook\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/test\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\" : true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -2542,57 +3608,58 @@ { "name": "Generate an HMAC key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/generateHmac", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId", - "generateHmac" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "" - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/generateHmac", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId", + "generateHmac" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "" + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2600,63 +3667,129 @@ { "name": "Test a webhook notification", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId", + "test" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : [ {\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"output\" : \"\",\n \"requestSent\" : \"{\\"live\\":\\"false\\",\\"notificationItems\\":[{\\"NotificationRequestItem\\":{\\"amount\\":{\\"currency\\":\\"EUR\\",\\"value\\":100},\\"eventCode\\":\\"AUTHORISATION\\",\\"eventDate\\":\\"2022-05-10T17:02:03+02:00\\",\\"merchantAccountCode\\":\\"YOUR_MERCHANT_ACCOUNT\\",\\"merchantReference\\":\\"4TZLD23Y\\",\\"operations\\":[\\"CANCEL\\",\\"CAPTURE\\",\\"REFUND\\"],\\"paymentMethod\\":\\"visa\\",\\"pspReference\\":\\"E05WW50L6IOBRGA0\\",\\"reason\\":\\"\\",\\"success\\":\\"true\\"}}]}\",\n \"responseCode\" : \"200\",\n \"responseTime\" : \"532 ms\",\n \"status\" : \"success\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId", + "test" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/test", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId", - "test" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -2669,57 +3802,58 @@ { "name": "Generate new client key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "generateClientKey" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "generateClientKey" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" +} + ,"response": [ + ] } ] } - ] }, { @@ -2732,57 +3866,58 @@ { "name": "Get a list of allowed origins", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2790,63 +3925,129 @@ { "name": "Add an allowed origin for the API credential", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"domain\" : \"https://www.eu.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -2854,63 +4055,64 @@ { "name": "Delete an allowed origin", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - }, - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2918,63 +4120,64 @@ { "name": "Get an allowed origin", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - }, - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -2987,56 +4190,57 @@ { "name": "Get a list of billing entities", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/billingEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "billingEntities" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "name", - "value": "name_example", - "description": "The name of the billing entity.", - "disabled": true - } - ] - }, - "description": "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/billingEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "billingEntities" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example", + "description": "The name of the billing entity.", + "disabled": true + } + ] + }, + "description": "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3044,68 +4248,69 @@ { "name": "Get a list of shipping locations", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "shippingLocations" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "name", - "value": "name_example", - "description": "The name of the shipping location.", - "disabled": true - }, - { - "key": "offset", - "value": "56", - "description": "The number of locations to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of locations to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "shippingLocations" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example", + "description": "The name of the shipping location.", + "disabled": true + }, + { + "key": "offset", + "value": "56", + "description": "The number of locations to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of locations to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3113,56 +4318,115 @@ { "name": "Create a shipping location", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"NL\"\n },\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "shippingLocations" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-7973536B20662642215526704F302044452F714622375D476169\",\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n },\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"NL\"\n },\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "shippingLocations" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"NL\"\n },\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "shippingLocations" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -3170,50 +4434,51 @@ { "name": "Get a list of terminal models", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalModels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalModels" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalModels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalModels" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3221,74 +4486,75 @@ { "name": "Get a list of orders", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "customerOrderReference", - "value": "customerOrderReference_example", - "description": "Your purchase order number.", - "disabled": true - }, - { - "key": "status", - "value": "status_example", - "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", - "disabled": true - }, - { - "key": "offset", - "value": "56", - "description": "The number of orders to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of orders to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "customerOrderReference", + "value": "customerOrderReference_example", + "description": "Your purchase order number.", + "disabled": true + }, + { + "key": "status", + "value": "status_example", + "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", + "disabled": true + }, + { + "key": "offset", + "value": "56", + "description": "The number of orders to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of orders to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -3296,56 +4562,115 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"Company.YOUR_COMPANY\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"5265677890100681\",\n \"customerOrderReference\" : \"YOUR_REFERENCE\",\n \"status\" : \"Placed\",\n \"shippingLocation\" : {\n \"id\" : \"S2-232A6D2967356F424F4369432B3F486B6A6D\",\n \"name\" : \"YOUR_COMPANY HQ - POS Ops\",\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"email\" : \"Paul.Green@company.com\"\n },\n \"address\" : {\n \"streetAddress\" : \"Simon Carmiggeltstraat\",\n \"streetAddress2\" : \"6-50\",\n \"postalCode\" : \"1011 DJ\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n }\n },\n \"billingEntity\" : {\n \"id\" : \"Company.YOUR_COMPANY\",\n \"name\" : \"YOUR_COMPANY\",\n \"taxId\" : \"NL1234567890\",\n \"email\" : \"Paul.Green@company.com\",\n \"address\" : {\n \"streetAddress\" : \"Simon Carmiggeltstraat 6-50\",\n \"postalCode\" : \"1011 DJ\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n }\n },\n \"orderDate\" : \"2022-01-20T14:12:33Z\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"Company.YOUR_COMPANY\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"Company.YOUR_COMPANY\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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", @@ -3353,56 +4678,57 @@ { "name": "Get an order", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders", - ":orderId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3410,62 +4736,127 @@ { "name": "Update a terminal order", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 5\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"5265677890100681\",\n \"customerOrderReference\" : \"YOUR_REFERENCE_1\",\n \"status\" : \"Placed\",\n \"shippingLocation\" : {\n \"id\" : \"S2-7973536B20662642215526704F302044452F714622375D476169\",\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n },\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"NL\"\n }\n },\n \"billingEntity\" : {\n \"id\" : \"Company.YOUR_COMPANY\",\n \"name\" : \"YOUR_COMPANY\",\n \"taxId\" : \"NL1234567890\",\n \"email\" : \"Paul.Green@company.com\",\n \"address\" : {\n \"streetAddress\" : \"Simon Carmiggeltstraat 6-50\",\n \"postalCode\" : \"1011 DJ\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n }\n },\n \"orderDate\" : \"2022-01-20T14:12:33Z\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 5\n } ]\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 5\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 5\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders", - ":orderId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -3473,57 +4864,58 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders", - ":orderId", - "cancel" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders", + ":orderId", + "cancel" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3531,74 +4923,75 @@ { "name": "Get a list of terminal products", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalProducts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalProducts" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "country", - "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", - "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", - "description": "The number of products to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of products to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalProducts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalProducts" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "country", + "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", + "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", + "description": "The number of products to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of products to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -3611,62 +5004,63 @@ { "name": "Get a list of API credentials", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. 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—API credentials read and write" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. 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—API credentials read and write" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3674,56 +5068,115 @@ { "name": "Add an API credential", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_API_CREDENTIAL\",\n \"username\" : \"YOUR_USERNAME\",\n \"clientKey\" : \"YOUR_CLIENT_KEY\",\n \"allowedIpAddresses\" : [ ],\n \"roles\" : [ \"Checkout webservice role\" ],\n \"active\" : true,\n \"allowedOrigins\" : [ {\n \"id\" : \"YOUR_ALLOWED_ORIGIN\",\n \"domain\" : \"https://www.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n } ],\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL\"\n },\n \"allowedOrigins\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins\"\n },\n \"generateApiKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey\"\n },\n \"generateClientKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey\"\n },\n \"merchant\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT\"\n }\n },\n \"apiKey\" : \"YOUR_API_KEY\",\n \"password\" : \"YOUR_PASSWORD\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -3731,56 +5184,57 @@ { "name": "Get an API credential", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3788,62 +5242,127 @@ { "name": "Activate an API credential", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_API_CREDENTIAL\",\n \"username\" : \"YOUR_USERNAME\",\n \"clientKey\" : \"YOUR_CLIENT_KEY\",\n \"allowedIpAddresses\" : [ ],\n \"roles\" : [ \"Checkout webservice role\", \"Merchant PAL Webservice role\" ],\n \"active\" : true,\n \"allowedOrigins\" : [ {\n \"id\" : \"YOUR_ALLOWED_ORIGIN\",\n \"domain\" : \"https://www.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n } ],\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL\"\n },\n \"allowedOrigins\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins\"\n },\n \"generateApiKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey\"\n },\n \"generateClientKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey\"\n },\n \"merchant\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\" : true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -3856,68 +5375,69 @@ { "name": "Get a list of users", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "users" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "Unique identifier of the merchant." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The partial or complete username to select all users that match.", - "disabled": true - } - ] - }, - "description": "Returns a list of users associated with 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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The partial or complete username to select all users that match.", + "disabled": true + } + ] + }, + "description": "Returns a list of users associated with 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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -3925,56 +5445,115 @@ { "name": "Create a user", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-3B3C3C3B22\",\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"username\" : \"johnsmith\",\n \"roles\" : [ \"Merchant standard role\" ],\n \"active\" : true,\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/users/S2-3B3C3C3B22\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + } + ], + "query": [ + ] + }, + "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 " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "users" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "Unique identifier of the merchant." - } - ], - "query": [ - ] - }, - "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 " - } + ] } ] - } -, + }, { "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 ", @@ -3982,56 +5561,57 @@ { "name": "Get user details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/users/:userId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "users", - ":userId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "Unique identifier of the merchant." - }, - { - "key": "userId", - "value": "", - "description": "Unique identifier of the user." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users", + ":userId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + }, + { + "key": "userId", + "value": "", + "description": "Unique identifier of the user." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4039,62 +5619,63 @@ { "name": "Update a user", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/users/:userId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "users", - ":userId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "Unique identifier of the merchant." - }, - { - "key": "userId", - "value": "", - "description": "Unique identifier of the user." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users", + ":userId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + }, + { + "key": "userId", + "value": "", + "description": "Unique identifier of the user." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] } - ] }, { @@ -4107,74 +5688,75 @@ { "name": "Get a list of terminal actions", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalActions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalActions" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "Returns terminal actions with the specified status. Allowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**.", - "disabled": true - }, - { - "key": "type", - "value": "type_example", - "description": "Returns terminal actions of the specified type. Allowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.", - "disabled": true - } - ] - }, - "description": "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalActions" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "Returns terminal actions with the specified status. Allowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**.", + "disabled": true + }, + { + "key": "type", + "value": "type_example", + "description": "Returns terminal actions of the specified type. Allowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.", + "disabled": true + } + ] + }, + "description": "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -4182,56 +5764,57 @@ { "name": "Get terminal action", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalActions/:actionId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalActions", - ":actionId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "actionId", - "value": "", - "description": "The unique identifier of the terminal action." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalActions/:actionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalActions", + ":actionId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "actionId", + "value": "", + "description": "The unique identifier of the terminal action." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -4244,74 +5827,75 @@ { "name": "Get all payment methods", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "storeId", - "value": "storeId_example", - "description": "The unique identifier of the store for which to return the payment methods.", - "disabled": true - }, - { - "key": "businessLineId", - "value": "businessLineId_example", - "description": "The unique identifier of the Business Line for which to return the payment methods.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The number of the page to fetch.", - "disabled": true - } - ] - }, - "description": "Returns details for all payment methods of 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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "storeId", + "value": "storeId_example", + "description": "The unique identifier of the store for which to return the payment methods.", + "disabled": true + }, + { + "key": "businessLineId", + "value": "businessLineId_example", + "description": "The unique identifier of the Business Line for which to return the payment methods.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The number of the page to fetch.", + "disabled": true + } + ] + }, + "description": "Returns details for all payment methods of 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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4319,106 +5903,225 @@ { "name": "Request a payment method", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"visa\",\n \"currencies\" : [ \"USD\" ],\n \"countries\" : [ \"US\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"PM3227C223224K5FH84M8CBNH\",\n \"type\" : \"visa\",\n \"countries\" : [ \"US\" ],\n \"currencies\" : [ \"USD\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"visa\",\n \"currencies\" : [ \"USD\" ],\n \"countries\" : [ \"US\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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 " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"visa\",\n \"currencies\" : [ \"USD\" ],\n \"countries\" : [ \"US\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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 " - } + ] }, { "name": "Request to add Swish", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessLineId\" : \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeId\" : \"ST322LJ223223K5F4SQNR9XL5\",\n \"type\" : \"swish\",\n \"swish\" : {\n \"swishNumber\" : \"1231111111\"\n },\n \"currencies\" : [ \"SEK\" ],\n \"countries\" : [ \"SE\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"PM3227C223224K5FH84M8CBNH\",\n \"businessLineId\" : \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeId\" : \"ST322LJ223223K5F4SQNR9XL5\",\n \"type\" : \"swish\",\n \"countries\" : [ \"SE\" ],\n \"currencies\" : [ \"SEK\" ],\n \"swish\" : {\n \"swishNumber\" : \"1231111111\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessLineId\" : \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeId\" : \"ST322LJ223223K5F4SQNR9XL5\",\n \"type\" : \"swish\",\n \"swish\" : {\n \"swishNumber\" : \"1231111111\"\n },\n \"currencies\" : [ \"SEK\" ],\n \"countries\" : [ \"SE\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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 " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessLineId\" : \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeId\" : \"ST322LJ223223K5F4SQNR9XL5\",\n \"type\" : \"swish\",\n \"swish\" : {\n \"swishNumber\" : \"1231111111\"\n },\n \"currencies\" : [ \"SEK\" ],\n \"countries\" : [ \"SE\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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 " - } + ] } ] - } -, + }, { "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 ", @@ -4426,56 +6129,57 @@ { "name": "Get payment method details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings", - ":paymentMethodId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "paymentMethodId", - "value": "", - "description": "The unique identifier of the payment method." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings", + ":paymentMethodId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4483,62 +6187,63 @@ { "name": "Update a payment method", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bcmc\": \"\",\n \"cartesBancaires\": \"\",\n \"countries\": \"\",\n \"cup\": \"\",\n \"currencies\": \"\",\n \"customRoutingFlags\": \"\",\n \"diners\": \"\",\n \"discover\": \"\",\n \"eftpos_australia\": \"\",\n \"enabled\": \"\",\n \"girocard\": \"\",\n \"ideal\": \"\",\n \"interac_card\": \"\",\n \"jcb\": \"\",\n \"maestro\": \"\",\n \"mc\": \"\",\n \"storeIds\": \"\",\n \"visa\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings", - ":paymentMethodId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "paymentMethodId", - "value": "", - "description": "The unique identifier of the payment method." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bcmc\": \"\",\n \"cartesBancaires\": \"\",\n \"countries\": \"\",\n \"cup\": \"\",\n \"currencies\": \"\",\n \"customRoutingFlags\": \"\",\n \"diners\": \"\",\n \"discover\": \"\",\n \"eftpos_australia\": \"\",\n \"enabled\": \"\",\n \"girocard\": \"\",\n \"ideal\": \"\",\n \"interac_card\": \"\",\n \"jcb\": \"\",\n \"maestro\": \"\",\n \"mc\": \"\",\n \"storeIds\": \"\",\n \"visa\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings", + ":paymentMethodId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4546,63 +6251,64 @@ { "name": "Add an Apple Pay domain", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domains\" : [ \"https://example.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings", - ":paymentMethodId", - "addApplePayDomains" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "paymentMethodId", - "value": "", - "description": "The unique identifier of the payment method." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domains\" : [ \"https://example.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings", + ":paymentMethodId", + "addApplePayDomains" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4610,57 +6316,58 @@ { "name": "Get Apple Pay domains", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings", - ":paymentMethodId", - "getApplePayDomains" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "paymentMethodId", - "value": "", - "description": "The unique identifier of the payment method." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings", + ":paymentMethodId", + "getApplePayDomains" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] } - ] }, { @@ -4673,43 +6380,44 @@ { "name": "Get API credential details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request. You can make this request with any of the Management API roles." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request. You can make this request with any of the Management API roles." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -4717,44 +6425,45 @@ { "name": "Get allowed origins", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "allowedOrigins" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -4762,50 +6471,51 @@ { "name": "Add allowed origin", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"_links\": \"\",\n \"domain\": \"\",\n \"id\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "allowedOrigins" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"_links\": \"\",\n \"domain\": \"\",\n \"id\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -4813,50 +6523,51 @@ { "name": "Remove allowed origin", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -4864,50 +6575,51 @@ { "name": "Get allowed origin details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -4915,44 +6627,45 @@ { "name": "Generate a client key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/generateClientKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "generateClientKey" - ], - "variable": [ - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/generateClientKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "generateClientKey" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -4965,56 +6678,57 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "description": "Returns the logo that is configured for a specific payment terminal model at the merchant account 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 the specified model under the merchant account, unless a different logo is 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "description": "Returns the logo that is configured for a specific payment terminal model at the merchant account 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 the specified model under the merchant account, unless a different logo is 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5022,118 +6736,249 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -5141,50 +6986,51 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5192,106 +7038,225 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"nexoEventUrls\" : [ \"https://your-event-notifications-endpoint.com\" ]\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"nexoEventUrls\" : [ \"https://your-event-notifications-endpoint.com\" ]\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -5304,91 +7269,92 @@ { "name": "Get a list of terminals", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals" - ], - "variable": [ - ], - "query": [ - { - "key": "searchQuery", - "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", - "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", - "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", - "description": "Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.", - "disabled": true - }, - { - "key": "storeIds", - "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", - "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", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the payment terminals that the API credential has access to and that match 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 — Terminal actions read" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals" + ], + "variable": [ + ], + "query": [ + { + "key": "searchQuery", + "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", + "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", + "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", + "description": "Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.", + "disabled": true + }, + { + "key": "storeIds", + "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", + "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", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the payment terminals that the API credential has access to and that match 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 — Terminal actions read" +} + ,"response": [ + ] } ] } - ] }, { @@ -5401,62 +7367,63 @@ { "name": "List all webhooks", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Lists all webhook configurations for the company account. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Lists all webhook configurations for the company account. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5464,56 +7431,115 @@ { "name": "Add a webhook configuration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"soap\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false,\n \"filterMerchantAccountType\" : \"includeAccounts\",\n \"filterMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-6933523D2772\",\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"description\" : \"Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE\",\n \"filterMerchantAccountType\" : \"includeAccounts\",\n \"filterMerchantAccounts\" : [ \"YOUR_MERCHANT_ACCOUNT\" ],\n \"username\" : \"myuser\",\n \"hasPassword\" : true,\n \"active\" : true,\n \"hasError\" : false,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"soap\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"certificateAlias\" : \"signed-test.adyen.com_2023\",\n \"populateSoapActionHeader\" : false,\n \"additionalSettings\" : {\n \"properties\" : {\n \"includePosTerminalInfo\" : false,\n \"includeARN\" : false,\n \"includePosDetails\" : false,\n \"includeCardInfoForRecurringContractNotification\" : false,\n \"includeRiskData\" : false,\n \"includeRiskExperimentReference\" : false,\n \"includeSoapSecurityHeader\" : false,\n \"includeContactlessWalletTokenInformation\" : false,\n \"includeAcquirerReference\" : false,\n \"includeRiskProfileReference\" : false,\n \"includeOriginalMerchantReferenceCancelOrRefundNotification\" : false,\n \"includeNfcTokenInformation\" : false,\n \"includeSubvariant\" : false,\n \"includeThreeDSVersion\" : false,\n \"includeInstallmentsInfo\" : false,\n \"includeAliasInfo\" : false,\n \"includeShopperCountry\" : false,\n \"includeRawThreeDSecureResult\" : false,\n \"includeAirlineData\" : false,\n \"includeGrossCurrencyChargebackDetails\" : false,\n \"includeThreeDSecureResult\" : false,\n \"includeMetadataIn3DSecurePaymentNotification\" : false,\n \"includeOriginalReferenceForChargebackReversed\" : false,\n \"addAcquirerResult\" : false,\n \"includeDeliveryAddress\" : false,\n \"includeRetryAttempts\" : false,\n \"includeExtraCosts\" : false,\n \"includeCardHolderName\" : false,\n \"includeShopperDetail\" : false,\n \"includeBankAccountDetails\" : false,\n \"includeMandateDetails\" : false,\n \"includeAuthAmountForDynamicZeroAuth\" : false,\n \"includeIssuerCountry\" : false,\n \"includeAcquirerErrorDetails\" : false,\n \"includeCoBrandedWith\" : false,\n \"includeShopperInteraction\" : false,\n \"includeDeviceAndBrowserInfo\" : false,\n \"addRawAcquirerResult\" : false,\n \"includeCardBin\" : false,\n \"includeFundingSource\" : false,\n \"includeThreeDS2ChallengeInformation\" : false,\n \"includeRiskProfile\" : false,\n \"includeRealtimeAccountUpdaterStatus\" : false,\n \"includeDunningProjectData\" : false,\n \"includePaymentResultInOrderClosedNotification\" : false,\n \"includeCardBinDetails\" : false,\n \"includeNotesInManualReviewNotifications\" : false,\n \"includeZeroAuthFlag\" : false,\n \"addCaptureReferenceToDisputeNotification\" : false,\n \"includePayPalDetails\" : false,\n \"includeRawThreeDSecureDetailsResult\" : false,\n \"includeBankVerificationResults\" : false,\n \"includeCaptureDelayHours\" : false,\n \"addPaymentAccountReference\" : false,\n \"includePayULatamDetails\" : false,\n \"includeStore\" : false,\n \"returnAvsData\" : false,\n \"includeWeChatPayOpenid\" : false,\n \"includeUpiVpa\" : false,\n \"includeCustomRoutingFlagging\" : false,\n \"includeTokenisedPaymentMetaData\" : false\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772\"\n },\n \"company\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT\"\n },\n \"generateHmac\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772/generateHmac\"\n },\n \"testWebhook\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772/test\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"soap\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false,\n \"filterMerchantAccountType\" : \"includeAccounts\",\n \"filterMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"soap\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false,\n \"filterMerchantAccountType\" : \"includeAccounts\",\n \"filterMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -5521,56 +7547,57 @@ { "name": "Remove a webhook", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5578,56 +7605,57 @@ { "name": "Get a webhook", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5635,62 +7663,127 @@ { "name": "Activate the webhook", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-4A3B33202A46\",\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"description\" : \"Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE\",\n \"filterMerchantAccountType\" : \"allAccounts\",\n \"username\" : \"\",\n \"hasPassword\" : false,\n \"active\" : true,\n \"hasError\" : false,\n \"sslVersion\" : \"TLSv1.2\",\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : false,\n \"acceptsUntrustedRootCertificate\" : false,\n \"populateSoapActionHeader\" : false,\n \"additionalSettings\" : {\n \"properties\" : {\n \"includePosTerminalInfo\" : false,\n \"includeARN\" : false,\n \"includePosDetails\" : false,\n \"includeCardInfoForRecurringContractNotification\" : false,\n \"includeRiskData\" : false,\n \"includeRiskExperimentReference\" : false,\n \"includeSoapSecurityHeader\" : false,\n \"includeContactlessWalletTokenInformation\" : false,\n \"includeAcquirerReference\" : false,\n \"includeRiskProfileReference\" : false,\n \"includeOriginalMerchantReferenceCancelOrRefundNotification\" : false,\n \"includeNfcTokenInformation\" : false,\n \"includeSubvariant\" : false,\n \"includeThreeDSVersion\" : false,\n \"includeInstallmentsInfo\" : false,\n \"includeAliasInfo\" : false,\n \"includeShopperCountry\" : false,\n \"includeRawThreeDSecureResult\" : false,\n \"includeAirlineData\" : false,\n \"includeGrossCurrencyChargebackDetails\" : false,\n \"includeThreeDSecureResult\" : false,\n \"includeMetadataIn3DSecurePaymentNotification\" : false,\n \"includeOriginalReferenceForChargebackReversed\" : false,\n \"addAcquirerResult\" : false,\n \"includeDeliveryAddress\" : false,\n \"includeRetryAttempts\" : false,\n \"includeExtraCosts\" : false,\n \"includeCardHolderName\" : false,\n \"includeShopperDetail\" : false,\n \"includeBankAccountDetails\" : false,\n \"includeMandateDetails\" : false,\n \"includeAuthAmountForDynamicZeroAuth\" : false,\n \"includeIssuerCountry\" : false,\n \"includeAcquirerErrorDetails\" : false,\n \"includeCoBrandedWith\" : false,\n \"includeShopperInteraction\" : false,\n \"includeDeviceAndBrowserInfo\" : false,\n \"addRawAcquirerResult\" : false,\n \"includeCardBin\" : false,\n \"includeFundingSource\" : false,\n \"includeThreeDS2ChallengeInformation\" : false,\n \"includeRiskProfile\" : false,\n \"includeRealtimeAccountUpdaterStatus\" : false,\n \"includeDunningProjectData\" : false,\n \"includePaymentResultInOrderClosedNotification\" : false,\n \"includeCardBinDetails\" : false,\n \"includeNotesInManualReviewNotifications\" : false,\n \"includeZeroAuthFlag\" : false,\n \"addCaptureReferenceToDisputeNotification\" : false,\n \"includePayPalDetails\" : false,\n \"includeRawThreeDSecureDetailsResult\" : false,\n \"includeBankVerificationResults\" : false,\n \"includeCaptureDelayHours\" : false,\n \"addPaymentAccountReference\" : false,\n \"includePayULatamDetails\" : false,\n \"includeStore\" : false,\n \"returnAvsData\" : false,\n \"includeWeChatPayOpenid\" : false,\n \"includeUpiVpa\" : false,\n \"includeCustomRoutingFlagging\" : false,\n \"includeTokenisedPaymentMetaData\" : false\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46\"\n },\n \"company\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT\"\n },\n \"generateHmac\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/generateHmac\"\n },\n \"testWebhook\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/test\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\" : true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -5698,57 +7791,58 @@ { "name": "Generate an HMAC key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/generateHmac", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId", - "generateHmac" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/generateHmac", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId", + "generateHmac" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5756,63 +7850,129 @@ { "name": "Test a webhook notification", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId", + "test" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : [ {\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_AU\",\n \"output\" : \"\",\n \"requestSent\" : \"{\\"live\\":\\"false\\",\\"notificationItems\\":[{\\"NotificationRequestItem\\":{\\"amount\\":{\\"currency\\":\\"EUR\\",\\"value\\":100},\\"eventCode\\":\\"AUTHORISATION\\",\\"eventDate\\":\\"2022-05-10T16:57:19+02:00\\",\\"merchantAccountCode\\":\\"YOUR_MERCHANT_ACCOUNT_AU\\",\\"merchantReference\\":\\"6GZBF5ML\\",\\"operations\\":[\\"CANCEL\\",\\"CAPTURE\\",\\"REFUND\\"],\\"paymentMethod\\":\\"visa\\",\\"pspReference\\":\\"KDN7UP7S1JIK6XES\\",\\"reason\\":\\"\\",\\"success\\":\\"true\\"}}]}\",\n \"responseCode\" : \"200\",\n \"responseTime\" : \"657 ms\",\n \"status\" : \"success\"\n }, {\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_EU\",\n \"output\" : \"\",\n \"requestSent\" : \"{\\"live\\":\\"false\\",\\"notificationItems\\":[{\\"NotificationRequestItem\\":{\\"amount\\":{\\"currency\\":\\"EUR\\",\\"value\\":100},\\"eventCode\\":\\"AUTHORISATION\\",\\"eventDate\\":\\"2022-05-10T16:57:19+02:00\\",\\"merchantAccountCode\\":\\"YOUR_MERCHANT_ACCOUNT_EU\\",\\"merchantReference\\":\\"6GZBF5ML\\",\\"operations\\":[\\"CANCEL\\",\\"CAPTURE\\",\\"REFUND\\"],\\"paymentMethod\\":\\"visa\\",\\"pspReference\\":\\"KDN7UP7S1JIK6XES\\",\\"reason\\":\\"\\",\\"success\\":\\"true\\"}}]}\",\n \"responseCode\" : \"200\",\n \"responseTime\" : \"590 ms\",\n \"status\" : \"success\"\n }, {\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_US\",\n \"output\" : \"\",\n \"requestSent\" : \"{\\"live\\":\\"false\\",\\"notificationItems\\":[{\\"NotificationRequestItem\\":{\\"amount\\":{\\"currency\\":\\"EUR\\",\\"value\\":100},\\"eventCode\\":\\"AUTHORISATION\\",\\"eventDate\\":\\"2022-05-10T16:57:19+02:00\\",\\"merchantAccountCode\\":\\"YOUR_MERCHANT_ACCOUNT_US\\",\\"merchantReference\\":\\"6GZBF5ML\\",\\"operations\\":[\\"CANCEL\\",\\"CAPTURE\\",\\"REFUND\\"],\\"paymentMethod\\":\\"visa\\",\\"pspReference\\":\\"KDN7UP7S1JIK6XES\\",\\"reason\\":\\"\\",\\"success\\":\\"true\\"}}]}\",\n \"responseCode\" : \"200\",\n \"responseTime\" : \"248 ms\",\n \"status\" : \"success\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId", + "test" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/test", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId", - "test" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -5825,68 +7985,69 @@ { "name": "Get a list of stores", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The reference of the store.", - "disabled": true - } - ] - }, - "description": "Returns a list of stores for the merchant account identified in the path. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The reference of the store.", + "disabled": true + } + ] + }, + "description": "Returns a list of stores for the merchant account identified in the path. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5894,56 +8055,115 @@ { "name": "Create a store under the merchant account specified in the path.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -5951,56 +8171,57 @@ { "name": "Get a store", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":storeId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6008,118 +8229,249 @@ { "name": "Update store address.", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20251\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":storeId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add split configuration to store", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20251\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n },\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":storeId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -6127,67 +8479,68 @@ { "name": "Get a list of stores", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores" - ], - "variable": [ - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The reference of the store.", - "disabled": true - }, - { - "key": "merchantId", - "value": "merchantId_example", - "description": "The unique identifier of the merchant account.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores" + ], + "variable": [ + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The reference of the store.", + "disabled": true + }, + { + "key": "merchantId", + "value": "merchantId_example", + "description": "The unique identifier of the merchant account.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6195,49 +8548,101 @@ { "name": "Create a store", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantId\" : \"{{YOUR_MERCHANT_ACCOUNT}}_ID\",\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantId\" : \"{{YOUR_MERCHANT_ACCOUNT}}_ID\",\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantId\" : \"{{YOUR_MERCHANT_ACCOUNT}}_ID\",\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores" - ], - "variable": [ - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -6245,49 +8650,50 @@ { "name": "Get a store", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6295,104 +8701,164 @@ { "name": "Update store address.", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20251\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add split configuration to store", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -6405,74 +8871,75 @@ { "name": "Get a list of Android apps", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/androidApps", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "androidApps" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The package name that uniquely identifies the Android app.", - "disabled": true - }, - { - "key": "versionCode", - "value": "56", - "description": "The version number of the app.", - "disabled": true - } - ] - }, - "description": "Returns a list of the Android apps that are available for the company 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 * Management API—Terminal actions read * Management API—Terminal actions read and write" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/androidApps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "androidApps" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The package name that uniquely identifies the Android app.", + "disabled": true + }, + { + "key": "versionCode", + "value": "56", + "description": "The version number of the app.", + "disabled": true + } + ] + }, + "description": "Returns a list of the Android apps that are available for the company 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 * Management API—Terminal actions read * Management API—Terminal actions read and write" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6480,56 +8947,57 @@ { "name": "Get Android app", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/androidApps/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "androidApps", - ":id" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "id", - "value": "", - "description": "The unique identifier of the app." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/androidApps/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "androidApps", + ":id" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "id", + "value": "", + "description": "The unique identifier of the app." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6537,68 +9005,69 @@ { "name": "Get a list of Android certificates", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/androidCertificates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "androidCertificates" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The name of the certificate.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/androidCertificates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "androidCertificates" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The name of the certificate.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -6611,56 +9080,57 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalLogos" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "description": "Returns the logo that is configured for a specific payment terminal model at the company 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 the specified model under the company, unless a different logo is 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "description": "Returns the logo that is configured for a specific payment terminal model at the company 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 the specified model under the company, unless a different logo is 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6668,118 +9138,249 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalLogos" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalLogos" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -6787,50 +9388,51 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalSettings" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6838,106 +9440,225 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalSettings" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalSettings" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -6950,62 +9671,63 @@ { "name": "Get a list of API credentials", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. 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—API credentials read and write" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. 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—API credentials read and write" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7013,56 +9735,115 @@ { "name": "Add an API credential", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}_AU\", \"{{YOUR_MERCHANT_ACCOUNT}}_EU\", \"{{YOUR_MERCHANT_ACCOUNT}}_US\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_API_CREDENTIAL\",\n \"username\" : \"YOUR_USERNAME\",\n \"clientKey\" : \"YOUR_CLIENT_KEY\",\n \"allowedIpAddresses\" : [ ],\n \"roles\" : [ \"Checkout webservice role\" ],\n \"active\" : true,\n \"allowedOrigins\" : [ {\n \"id\" : \"YOUR_ALLOWED_ORIGIN\",\n \"domain\" : \"https://www.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n } ],\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL\"\n },\n \"allowedOrigins\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins\"\n },\n \"company\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT\"\n },\n \"generateApiKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey\"\n },\n \"generateClientKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey\"\n }\n },\n \"apiKey\" : \"YOUR_API_KEY\",\n \"password\" : \"YOUR_PASSWORD\",\n \"associatedMerchantAccounts\" : [ \"YOUR_MERCHANT_ACCOUNT_AU\", \"YOUR_MERCHANT_ACCOUNT_EU\", \"YOUR_MERCHANT_ACCOUNT_US\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}_AU\", \"{{YOUR_MERCHANT_ACCOUNT}}_EU\", \"{{YOUR_MERCHANT_ACCOUNT}}_US\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}_AU\", \"{{YOUR_MERCHANT_ACCOUNT}}_EU\", \"{{YOUR_MERCHANT_ACCOUNT}}_US\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -7070,56 +9851,57 @@ { "name": "Get an API credential", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7127,62 +9909,127 @@ { "name": "Activate an API credential", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_API_CREDENTIAL\",\n \"username\" : \"YOUR_USERNAME\",\n \"clientKey\" : \"YOUR_CLIENT_KEY\",\n \"allowedIpAddresses\" : [ ],\n \"roles\" : [ \"Management API - Accounts read\", \"Management API - Webhooks read\", \"Management API - API credentials read and write\", \"Management API - Stores read\", \"Management API — Payment methods read\", \"Management API - Stores read and write\", \"Management API - Webhooks read and write\", \"Merchant Recurring role\", \"Data Protection API\", \"Management API - Payout Account Settings Read\", \"Checkout webservice role\", \"Management API - Accounts read and write\", \"Merchant PAL Webservice role\" ],\n \"active\" : true,\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL\"\n },\n \"allowedOrigins\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins\"\n },\n \"company\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT\"\n },\n \"generateApiKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey\"\n },\n \"generateClientKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey\"\n }\n },\n \"associatedMerchantAccounts\" : [ ]\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\" : true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -7195,56 +10042,57 @@ { "name": "Get a list of billing entities", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/billingEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "billingEntities" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "name", - "value": "name_example", - "description": "The name of the billing entity.", - "disabled": true - } - ] - }, - "description": "Returns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/billingEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "billingEntities" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example", + "description": "The name of the billing entity.", + "disabled": true + } + ] + }, + "description": "Returns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7252,68 +10100,69 @@ { "name": "Get a list of shipping locations", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "shippingLocations" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "name", - "value": "name_example", - "description": "The name of the shipping location.", - "disabled": true - }, - { - "key": "offset", - "value": "56", - "description": "The number of locations to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of locations to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "shippingLocations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example", + "description": "The name of the shipping location.", + "disabled": true + }, + { + "key": "offset", + "value": "56", + "description": "The number of locations to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of locations to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7321,56 +10170,115 @@ { "name": "Create a shipping location", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : \"{{YOUR_MERCHANT_ACCOUNT}} Barcelona depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"ES\"\n },\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34 93 1234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "shippingLocations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-73536B20665526704F30792642212044452F714622375D477270\",\n \"name\" : \"YOUR_MERCHANT_ACCOUNT Barcelona depot\",\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34931234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n },\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : \"{{YOUR_MERCHANT_ACCOUNT}} Barcelona depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"ES\"\n },\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34 93 1234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "shippingLocations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\" : \"{{YOUR_MERCHANT_ACCOUNT}} Barcelona depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"ES\"\n },\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34 93 1234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "shippingLocations" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -7378,50 +10286,51 @@ { "name": "Get a list of terminal models", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalModels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalModels" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalModels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalModels" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7429,74 +10338,75 @@ { "name": "Get a list of orders", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "" - } - ], - "query": [ - { - "key": "customerOrderReference", - "value": "customerOrderReference_example", - "description": "Your purchase order number.", - "disabled": true - }, - { - "key": "status", - "value": "status_example", - "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", - "disabled": true - }, - { - "key": "offset", - "value": "56", - "description": "The number of orders to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of orders to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "" + } + ], + "query": [ + { + "key": "customerOrderReference", + "value": "customerOrderReference_example", + "description": "Your purchase order number.", + "disabled": true + }, + { + "key": "status", + "value": "status_example", + "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", + "disabled": true + }, + { + "key": "offset", + "value": "56", + "description": "The number of orders to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of orders to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -7504,56 +10414,115 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"MerchantAccount.{{YOUR_MERCHANT_ACCOUNT}}\",\n \"items\" : [ {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"4154567890100682\",\n \"customerOrderReference\" : \"YOUR_REFERENCE\",\n \"status\" : \"Placed\",\n \"shippingLocation\" : {\n \"id\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"name\" : \"YOUR_COMPANY Spain\",\n \"contact\" : {\n \"firstName\" : \"Pablo\",\n \"lastName\" : \"Mengano\",\n \"phoneNumber\" : \"+34911234567\",\n \"email\" : \"Pablo.Mengano@company.com\"\n },\n \"address\" : {\n \"streetAddress\" : \"Paseo de la Castellana 43\",\n \"streetAddress2\" : \"7 piso\",\n \"postalCode\" : \"28046\",\n \"city\" : \"Madrid\",\n \"country\" : \"ES\"\n }\n },\n \"billingEntity\" : {\n \"id\" : \"MerchantAccount.YOUR_MERCHANT_ACCOUNT\",\n \"name\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"taxId\" : \"ES1234567890\",\n \"email\" : \"Pablo.Mengano@company.com\",\n \"address\" : {\n \"streetAddress\" : \"Paseo de la Castellana 43, 7\",\n \"postalCode\" : \"28046\",\n \"city\" : \"Madrid\",\n \"country\" : \"ES\"\n }\n },\n \"orderDate\" : \"2022-01-21T16:12:33Z\",\n \"items\" : [ {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"MerchantAccount.{{YOUR_MERCHANT_ACCOUNT}}\",\n \"items\" : [ {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"MerchantAccount.{{YOUR_MERCHANT_ACCOUNT}}\",\n \"items\" : [ {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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", @@ -7561,56 +10530,57 @@ { "name": "Get an order", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders", - ":orderId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7618,62 +10588,127 @@ { "name": "Update a terminal order", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"4154567890100682\",\n \"customerOrderReference\" : \"YOUR_REFERENCE\",\n \"status\" : \"Placed\",\n \"shippingLocation\" : {\n \"id\" : \"S2-73536B20665526704F30792642212044452F714622375D477270\",\n \"name\" : \"YOUR_MERCHANT_ACCOUNT Barcelona depot\",\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34931234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n },\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"ES\"\n }\n },\n \"billingEntity\" : {\n \"id\" : \"MerchantAccount.YOUR_MERCHANT_ACCOUNT\",\n \"name\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"taxId\" : \"ES1234567890\",\n \"email\" : \"Pablo.Mengano@company.com\",\n \"address\" : {\n \"streetAddress\" : \"Paseo de la Castellana 43, 7\",\n \"postalCode\" : \"28046\",\n \"city\" : \"Madrid\",\n \"country\" : \"ES\"\n }\n },\n \"orderDate\" : \"2022-01-21T16:12:33Z\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders", - ":orderId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -7681,57 +10716,58 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders", - ":orderId", - "cancel" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders", + ":orderId", + "cancel" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7739,74 +10775,75 @@ { "name": "Get a list of terminal products", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalProducts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalProducts" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "country", - "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", - "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", - "description": "The number of products to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of products to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalProducts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalProducts" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "country", + "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", + "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", + "description": "The number of products to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of products to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -7819,55 +10856,56 @@ { "name": "Get a list of company accounts", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies" - ], - "variable": [ - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the list of company 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies" + ], + "variable": [ + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the list of company 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7875,49 +10913,50 @@ { "name": "Get a company account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7925,62 +10964,63 @@ { "name": "Get a list of merchant accounts", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/merchants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "merchants" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "merchants" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -7993,63 +11033,64 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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 the specified 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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 the specified 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -8057,132 +11098,277 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -8190,57 +11376,58 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -8248,120 +11435,253 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -8369,56 +11689,57 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalLogos" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -8426,118 +11747,249 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalLogos" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalLogos" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -8545,50 +11997,51 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalSettings" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -8596,106 +12049,225 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalSettings" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalSettings" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] } ], diff --git a/postman/ManagementService-v3.json b/postman/ManagementService-v3.json index 8e0fa52..8e0eabb 100644 --- a/postman/ManagementService-v3.json +++ b/postman/ManagementService-v3.json @@ -19,57 +19,58 @@ { "name": "Generate new API key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "generateApiKey" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "generateApiKey" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" +} + ,"response": [ + ] } ] } - ] }, { @@ -82,55 +83,56 @@ { "name": "Get a list of merchant accounts", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants" - ], - "variable": [ - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the list of 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants" + ], + "variable": [ + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the list of 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -138,49 +140,101 @@ { "name": "Create a merchant account for an Adyen for Platforms Manage integration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyId\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"legalEntityId\" : \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\" : \"YOUR_BUSINESS_LINE_ID\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"reference\" : \"YOUR_OWN_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"companyId\" : \"YOUR_COMPANY_ACCOUNT\",\n \"legalEntityId\" : \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\" : \"YOUR_BUSINESS_LINE_ID\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"reference\" : \"YOUR_OWN_REFERENCE\",\n \"id\" : \"YOUR_OWN_REFERENCE\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyId\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"legalEntityId\" : \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\" : \"YOUR_BUSINESS_LINE_ID\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"reference\" : \"YOUR_OWN_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyId\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"legalEntityId\" : \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\" : \"YOUR_BUSINESS_LINE_ID\",\n \"description\" : \"YOUR_DESCRIPTION\",\n \"reference\" : \"YOUR_OWN_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants" - ], - "variable": [ - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -188,49 +242,50 @@ { "name": "Get a merchant account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -238,50 +293,51 @@ { "name": "Request to activate a merchant account", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/activate", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "activate" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/activate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "activate" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -294,50 +350,51 @@ { "name": "Get a list of split configurations", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "description": "Returns the list of split configurations for the merchant account. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Returns the list of split configurations for the merchant account. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -345,56 +402,115 @@ { "name": "Create a split configuration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"paymentMethod\" : \"ANY\",\n \"shopperInteraction\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"ANY\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"paymentMethod\" : \"ANY\",\n \"shopperInteraction\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"ANY\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"paymentMethod\" : \"ANY\",\n \"shopperInteraction\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"ANY\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -402,56 +518,57 @@ { "name": "Delete a split configuration", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -459,56 +576,57 @@ { "name": "Get a split configuration", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -516,62 +634,127 @@ { "name": "Update split configuration description", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Updated description for the split configuration\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Updated description for the split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n }, {\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"ruleId\" : \"SCRL4224P22322585HPCX5V4KV6L2R\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX5V4KW26C9\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"Updated description for the split configuration\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"Updated description for the split configuration\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -579,62 +762,127 @@ { "name": "Add rule to a split configuration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"POS\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"USD\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"My first split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n }, {\n \"currency\" : \"USD\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"ruleId\" : \"SCRL4224P22322585HPCX5V4KV6L2R\",\n \"shopperInteraction\" : \"POS\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX5V4KW26C9\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"POS\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"USD\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"POS\",\n \"fundingSource\" : \"ANY\",\n \"currency\" : \"USD\",\n \"splitLogic\" : {\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"chargeback\" : \"deductFromLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -642,63 +890,64 @@ { "name": "Delete a split configuration rule", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId", - "rules", - ":ruleId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - }, - { - "key": "ruleId", - "value": "", - "description": "" - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "" + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -706,69 +955,141 @@ { "name": "Update the conditions in split configuration rule", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"ANY\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "The unique identifier of the split configuration rule." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n }, {\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"ruleId\" : \"SCRL4224P22322585HPCX5V4KV6L2R\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX5V4KW26C9\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"ANY\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "The unique identifier of the split configuration rule." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"shopperInteraction\" : \"ANY\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId", - "rules", - ":ruleId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The identifier of the split configuration." - }, - { - "key": "ruleId", - "value": "", - "description": "The unique identifier of the split configuration rule." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -776,76 +1097,155 @@ { "name": "Update the split logic", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId", + "splitLogic", + ":splitLogicId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "The unique identifier of the split configuration rule." + }, + { + "key": "splitLogicId", + "value": "", + "description": "The unique identifier of the split configuration split." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"description\" : \"Your description for the split configuration\",\n \"rules\" : [ {\n \"currency\" : \"ANY\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"ANY\",\n \"ruleId\" : \"SCRL4224P22322585HPCX384JW65VW\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 50,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 10,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX384JX52M2\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToOneBalanceAccount\",\n \"tip\" : \"addToOneBalanceAccount\"\n }\n }, {\n \"currency\" : \"EUR\",\n \"fundingSource\" : \"ANY\",\n \"paymentMethod\" : \"visa\",\n \"ruleId\" : \"SCRL4224P22322585HPCX5V4KV6L2R\",\n \"shopperInteraction\" : \"ANY\",\n \"splitLogic\" : {\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"splitLogicId\" : \"SCLG4224P22322585HPCX5V4KW26C9\",\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n }\n } ],\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "splitConfigurations", + ":splitConfigurationId", + "rules", + ":ruleId", + "splitLogic", + ":splitLogicId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "splitConfigurationId", + "value": "", + "description": "The unique identifier of the split configuration." + }, + { + "key": "ruleId", + "value": "", + "description": "The unique identifier of the split configuration rule." + }, + { + "key": "splitLogicId", + "value": "", + "description": "The unique identifier of the split configuration split." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"additionalCommission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 0,\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\"\n },\n \"chargeback\" : \"deductFromLiableAccount\",\n \"commission\" : {\n \"fixedAmount\" : 100,\n \"variablePercentage\" : 100\n },\n \"paymentFee\" : \"deductFromLiableAccount\",\n \"remainder\" : \"addToLiableAccount\",\n \"tip\" : \"addToLiableAccount\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "splitConfigurations", - ":splitConfigurationId", - "rules", - ":ruleId", - "splitLogic", - ":splitLogicId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "splitConfigurationId", - "value": "", - "description": "The unique identifier of the split configuration." - }, - { - "key": "ruleId", - "value": "", - "description": "The unique identifier of the split configuration rule." - }, - { - "key": "splitLogicId", - "value": "", - "description": "The unique identifier of the split configuration split." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -858,57 +1258,58 @@ { "name": "Get a list of allowed origins", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -916,63 +1317,129 @@ { "name": "Add an allowed origin for the API credential", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_ALLOWED_ORIGIN\",\n \"domain\" : \"https://www.eu.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -980,63 +1447,64 @@ { "name": "Delete an allowed origin", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - }, - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -1044,63 +1512,64 @@ { "name": "Get an allowed origin", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - }, - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -1113,57 +1582,58 @@ { "name": "Generate new API key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "generateApiKey" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "generateApiKey" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" +} + ,"response": [ + ] } ] } - ] }, { @@ -1176,57 +1646,58 @@ { "name": "Generate new client key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId", - "generateClientKey" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId", + "generateClientKey" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" +} + ,"response": [ + ] } ] } - ] }, { @@ -1239,68 +1710,69 @@ { "name": "Get a list of users", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "users" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to return.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The partial or complete username to select all users that match.", - "disabled": true - } - ] - }, - "description": "Returns the list of users 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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to return.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The partial or complete username to select all users that match.", + "disabled": true + } + ] + }, + "description": "Returns the list of users 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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -1308,56 +1780,115 @@ { "name": "Create a user", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\", \"Merchant admin\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-5C334C6770\",\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"username\" : \"johnsmith\",\n \"roles\" : [ \"Merchant standard role\", \"Merchant admin\" ],\n \"active\" : true,\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users/S2-5C334C6770\"\n }\n },\n \"associatedMerchantAccounts\" : [ \"YOUR_MERCHANT_ACCOUNT\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\", \"Merchant admin\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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 " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\", \"Merchant admin\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "users" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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 " - } + ] } ] - } -, + }, { "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 ", @@ -1365,56 +1896,57 @@ { "name": "Get user details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/users/:userId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "users", - ":userId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "userId", - "value": "", - "description": "The unique identifier of the user." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users", + ":userId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "userId", + "value": "", + "description": "The unique identifier of the user." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -1422,62 +1954,63 @@ { "name": "Update user details", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"associatedMerchantAccounts\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/users/:userId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "users", - ":userId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "userId", - "value": "", - "description": "The unique identifier of the user." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"associatedMerchantAccounts\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "users", + ":userId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "userId", + "value": "", + "description": "The unique identifier of the user." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] } - ] }, { @@ -1490,138 +2023,299 @@ { "name": "Schedule installing an Android app", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF732K8\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"actionDetails\" : {\n \"appId\" : \"ANDA422LZ223223K5F694GCCF732K8\",\n \"type\" : \"InstallAndroidApp\"\n },\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"storeId\" : \"\",\n \"items\" : [ {\n \"id\" : \"TRAC422T2223223K5GFMQHM6WQ4KB6\",\n \"terminalId\" : \"S1E-000150183300032\"\n }, {\n \"id\" : \"TRAC4224X22338VQ5GD4CQJCQT5PC2\",\n \"terminalId\" : \"S1E-000150183300033\"\n }, {\n \"id\" : \"TRAC4224Z223223K5GD89RLBWQ6CWT\",\n \"terminalId\" : \"S1F2-000150183300034\"\n } ],\n \"terminalsWithErrors\" : { },\n \"totalScheduled\" : 3,\n \"totalErrors\" : 0\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF732K8\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF732K8\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/scheduleActions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - "scheduleActions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" - } + ] }, { "name": "Schedule uninstalling an Android certificate", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"UninstallAndroidCertificate\",\n \"certificateId\" : \"ANDC422LZ223223K5F78NVN9SL4VPH\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"actionDetails\" : {\n \"certificateId\" : \"ANDC422LZ223223K5F78NVN9SL4VPH\",\n \"type\" : \"UninstallAndroidCertificate\"\n },\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"storeId\" : \"\",\n \"items\" : [ {\n \"id\" : \"TRAC422T2223223K5GFMQHM6WQ4KB6\",\n \"terminalId\" : \"S1E-000150183300032\"\n }, {\n \"id\" : \"TRAC4224X22338VQ5GD4CQJCQT5PC2\",\n \"terminalId\" : \"S1E-000150183300033\"\n }, {\n \"id\" : \"TRAC4224Z223223K5GD89RLBWQ6CWT\",\n \"terminalId\" : \"S1F2-000150183300034\"\n } ],\n \"terminalsWithErrors\" : { },\n \"totalScheduled\" : 3,\n \"totalErrors\" : 0\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"UninstallAndroidCertificate\",\n \"certificateId\" : \"ANDC422LZ223223K5F78NVN9SL4VPH\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-12T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"UninstallAndroidCertificate\",\n \"certificateId\" : \"ANDC422LZ223223K5F78NVN9SL4VPH\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/scheduleActions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - "scheduleActions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" - } + ] }, { "name": "Invalid terminal ID in the request", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-11T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF621J7\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} + ,"response": [ + {"name": "Unprocessable Entity - a request validation error.", + "code": 422, + "status": "Unprocessable Entity", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"type\" : \"https://docs.adyen.com/errors/unprocessable-entity\",\n \"errorCode\" : \"02_005\",\n \"title\" : \"Terminal ID verification failed.\",\n \"status\" : 422,\n \"detail\" : \"Terminal IDs are empty\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-11T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF621J7\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"terminalIds\" : [ \"S1E-000150183300032\", \"S1E-000150183300033\", \"S1F2-000150183300034\" ],\n \"storeId\" : \"\",\n \"scheduledAt\" : \"2021-12-11T20:21:22-0100\",\n \"actionDetails\" : {\n \"type\" : \"InstallAndroidApp\",\n \"appId\" : \"ANDA422LZ223223K5F694GCCF621J7\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/scheduleActions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - "scheduleActions" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. 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 actions read and write" - } + ] } ] } - ] }, { @@ -1634,50 +2328,51 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalLogos" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "description": "Returns the logo that is configured for the payment terminal 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. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "description": "Returns the logo that is configured for the payment terminal 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. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -1685,106 +2380,225 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalLogos" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalLogos" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -1792,50 +2606,51 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalSettings" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -1843,106 +2658,225 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"notification\" : {\n \"showButton\" : true\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75,\n \"restartHour\" : 5\n },\n \"passcodes\" : {\n \"adminMenuPin\" : \"1234\",\n \"txMenuPin\" : \"1234\",\n \"refundPin\" : \"123456\",\n \"screenLockPin\" : \"1111\"\n },\n \"connectivity\" : {\n \"simcardStatus\" : \"INVENTORY\"\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalSettings" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"notification\" : {\n \"showButton\" : true\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75,\n \"restartHour\" : 5\n },\n \"passcodes\" : {\n \"adminMenuPin\" : \"1234\",\n \"txMenuPin\" : \"1234\",\n \"refundPin\" : \"123456\",\n \"screenLockPin\" : \"1111\"\n },\n \"connectivity\" : {\n \"simcardStatus\" : \"INVENTORY\"\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "terminalSettings" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -1955,50 +2889,51 @@ { "name": "Get a list of payout settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "description": "Returns the list of payout settings for the merchant account 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Returns the list of payout settings for the merchant account 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2006,56 +2941,57 @@ { "name": "Add a payout setting", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"enabled\": \"\",\n \"enabledFromDate\": \"\",\n \"transferInstrumentId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"enabledFromDate\": \"\",\n \"transferInstrumentId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2063,56 +2999,57 @@ { "name": "Delete a payout setting", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings", - ":payoutSettingsId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "payoutSettingsId", - "value": "", - "description": "The unique identifier of the payout setting." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings", + ":payoutSettingsId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "payoutSettingsId", + "value": "", + "description": "The unique identifier of the payout setting." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2120,56 +3057,57 @@ { "name": "Get a payout setting", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings", - ":payoutSettingsId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "payoutSettingsId", - "value": "", - "description": "The unique identifier of the payout setting." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings", + ":payoutSettingsId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "payoutSettingsId", + "value": "", + "description": "The unique identifier of the payout setting." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2177,62 +3115,63 @@ { "name": "Update a payout setting", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"enabled\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "payoutSettings", - ":payoutSettingsId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "payoutSettingsId", - "value": "", - "description": "The unique identifier of the payout setting." - } - ], - "query": [ - ] - }, - "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" - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/payoutSettings/:payoutSettingsId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "payoutSettings", + ":payoutSettingsId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "payoutSettingsId", + "value": "", + "description": "The unique identifier of the payout setting." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -2245,62 +3184,63 @@ { "name": "List all webhooks", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Lists all webhook configurations for the merchant account. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Lists all webhook configurations for the merchant account. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2308,56 +3248,115 @@ { "name": "Add a webhook configuration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-31433949437F\",\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"description\" : \"Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE\",\n \"username\" : \"myuser\",\n \"hasPassword\" : true,\n \"active\" : true,\n \"hasError\" : false,\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"certificateAlias\" : \"signed-test.adyen.com_2023\",\n \"populateSoapActionHeader\" : false,\n \"additionalSettings\" : {\n \"properties\" : {\n \"includePosTerminalInfo\" : false,\n \"includeARN\" : false,\n \"includePosDetails\" : false,\n \"includeCardInfoForRecurringContractNotification\" : false,\n \"includeRiskData\" : false,\n \"includeRiskExperimentReference\" : false,\n \"includeSoapSecurityHeader\" : false,\n \"includeContactlessWalletTokenInformation\" : false,\n \"includeAcquirerReference\" : false,\n \"includeRiskProfileReference\" : false,\n \"includeOriginalMerchantReferenceCancelOrRefundNotification\" : false,\n \"includeNfcTokenInformation\" : false,\n \"includeSubvariant\" : false,\n \"includeThreeDSVersion\" : false,\n \"includeInstallmentsInfo\" : false,\n \"includeAliasInfo\" : false,\n \"includeShopperCountry\" : false,\n \"includeRawThreeDSecureResult\" : false,\n \"includeAirlineData\" : false,\n \"includeGrossCurrencyChargebackDetails\" : false,\n \"includeThreeDSecureResult\" : false,\n \"includeMetadataIn3DSecurePaymentNotification\" : false,\n \"includeOriginalReferenceForChargebackReversed\" : false,\n \"addAcquirerResult\" : false,\n \"includeDeliveryAddress\" : false,\n \"includeRetryAttempts\" : false,\n \"includeExtraCosts\" : false,\n \"includeCardHolderName\" : false,\n \"includeShopperDetail\" : false,\n \"includeBankAccountDetails\" : false,\n \"includeMandateDetails\" : false,\n \"includeAuthAmountForDynamicZeroAuth\" : false,\n \"includeIssuerCountry\" : false,\n \"includeAcquirerErrorDetails\" : false,\n \"includeCoBrandedWith\" : false,\n \"includeShopperInteraction\" : false,\n \"includeDeviceAndBrowserInfo\" : false,\n \"addRawAcquirerResult\" : false,\n \"includeCardBin\" : false,\n \"includeFundingSource\" : false,\n \"includeThreeDS2ChallengeInformation\" : false,\n \"includeRiskProfile\" : false,\n \"includeRealtimeAccountUpdaterStatus\" : false,\n \"includeDunningProjectData\" : false,\n \"includePaymentResultInOrderClosedNotification\" : false,\n \"includeCardBinDetails\" : false,\n \"includeNotesInManualReviewNotifications\" : false,\n \"includeZeroAuthFlag\" : false,\n \"addCaptureReferenceToDisputeNotification\" : false,\n \"includePayPalDetails\" : false,\n \"includeRawThreeDSecureDetailsResult\" : false,\n \"includeBankVerificationResults\" : false,\n \"includeCaptureDelayHours\" : false,\n \"addPaymentAccountReference\" : false,\n \"includePayULatamDetails\" : false,\n \"includeStore\" : false,\n \"returnAvsData\" : false,\n \"includeWeChatPayOpenid\" : false,\n \"includeUpiVpa\" : false,\n \"includeCustomRoutingFlagging\" : false,\n \"includeTokenisedPaymentMetaData\" : false\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F\"\n },\n \"generateHmac\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F/generateHmac\"\n },\n \"merchant\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT\"\n },\n \"testWebhook\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F/test\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -2365,56 +3364,57 @@ { "name": "Remove a webhook", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2422,56 +3422,57 @@ { "name": "Get a webhook", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2479,62 +3480,127 @@ { "name": "Activate the webhook", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-3E5E42476641\",\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"description\" : \"Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE\",\n \"username\" : \"\",\n \"hasPassword\" : false,\n \"active\" : true,\n \"hasError\" : false,\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : false,\n \"acceptsUntrustedRootCertificate\" : false,\n \"populateSoapActionHeader\" : false,\n \"additionalSettings\" : {\n \"properties\" : {\n \"includePosTerminalInfo\" : false,\n \"includeARN\" : false,\n \"includePosDetails\" : false,\n \"includeCardInfoForRecurringContractNotification\" : false,\n \"includeRiskData\" : false,\n \"includeRiskExperimentReference\" : false,\n \"includeSoapSecurityHeader\" : false,\n \"includeContactlessWalletTokenInformation\" : false,\n \"includeAcquirerReference\" : false,\n \"includeRiskProfileReference\" : false,\n \"includeOriginalMerchantReferenceCancelOrRefundNotification\" : false,\n \"includeNfcTokenInformation\" : false,\n \"includeSubvariant\" : false,\n \"includeThreeDSVersion\" : false,\n \"includeInstallmentsInfo\" : false,\n \"includeAliasInfo\" : false,\n \"includeShopperCountry\" : false,\n \"includeRawThreeDSecureResult\" : false,\n \"includeAirlineData\" : false,\n \"includeGrossCurrencyChargebackDetails\" : false,\n \"includeThreeDSecureResult\" : false,\n \"includeMetadataIn3DSecurePaymentNotification\" : false,\n \"includeOriginalReferenceForChargebackReversed\" : false,\n \"addAcquirerResult\" : false,\n \"includeDeliveryAddress\" : false,\n \"includeRetryAttempts\" : false,\n \"includeExtraCosts\" : false,\n \"includeCardHolderName\" : false,\n \"includeShopperDetail\" : false,\n \"includeBankAccountDetails\" : false,\n \"includeMandateDetails\" : false,\n \"includeAuthAmountForDynamicZeroAuth\" : false,\n \"includeIssuerCountry\" : false,\n \"includeAcquirerErrorDetails\" : false,\n \"includeCoBrandedWith\" : false,\n \"includeShopperInteraction\" : false,\n \"includeDeviceAndBrowserInfo\" : false,\n \"addRawAcquirerResult\" : false,\n \"includeCardBin\" : false,\n \"includeFundingSource\" : false,\n \"includeThreeDS2ChallengeInformation\" : false,\n \"includeRiskProfile\" : false,\n \"includeRealtimeAccountUpdaterStatus\" : false,\n \"includeDunningProjectData\" : false,\n \"includePaymentResultInOrderClosedNotification\" : false,\n \"includeCardBinDetails\" : false,\n \"includeNotesInManualReviewNotifications\" : false,\n \"includeZeroAuthFlag\" : false,\n \"addCaptureReferenceToDisputeNotification\" : false,\n \"includePayPalDetails\" : false,\n \"includeRawThreeDSecureDetailsResult\" : false,\n \"includeBankVerificationResults\" : false,\n \"includeCaptureDelayHours\" : false,\n \"addPaymentAccountReference\" : false,\n \"includePayULatamDetails\" : false,\n \"includeStore\" : false,\n \"returnAvsData\" : false,\n \"includeWeChatPayOpenid\" : false,\n \"includeUpiVpa\" : false,\n \"includeCustomRoutingFlagging\" : false,\n \"includeTokenisedPaymentMetaData\" : false\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641\"\n },\n \"generateHmac\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/generateHmac\"\n },\n \"merchant\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT\"\n },\n \"testWebhook\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/test\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\" : true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -2542,57 +3608,58 @@ { "name": "Generate an HMAC key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/generateHmac", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId", - "generateHmac" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "" - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/generateHmac", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId", + "generateHmac" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "" + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2600,63 +3667,129 @@ { "name": "Test a webhook notification", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId", + "test" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : [ {\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"output\" : \"\",\n \"requestSent\" : \"{\\"live\\":\\"false\\",\\"notificationItems\\":[{\\"NotificationRequestItem\\":{\\"amount\\":{\\"currency\\":\\"EUR\\",\\"value\\":100},\\"eventCode\\":\\"AUTHORISATION\\",\\"eventDate\\":\\"2022-05-10T17:02:03+02:00\\",\\"merchantAccountCode\\":\\"YOUR_MERCHANT_ACCOUNT\\",\\"merchantReference\\":\\"4TZLD23Y\\",\\"operations\\":[\\"CANCEL\\",\\"CAPTURE\\",\\"REFUND\\"],\\"paymentMethod\\":\\"visa\\",\\"pspReference\\":\\"E05WW50L6IOBRGA0\\",\\"reason\\":\\"\\",\\"success\\":\\"true\\"}}]}\",\n \"responseCode\" : \"200\",\n \"responseTime\" : \"532 ms\",\n \"status\" : \"success\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "webhooks", + ":webhookId", + "test" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/webhooks/:webhookId/test", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "webhooks", - ":webhookId", - "test" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -2669,57 +3802,58 @@ { "name": "Generate new client key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "generateClientKey" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "generateClientKey" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" +} + ,"response": [ + ] } ] } - ] }, { @@ -2732,57 +3866,58 @@ { "name": "Get a list of allowed origins", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2790,63 +3925,129 @@ { "name": "Add an allowed origin for the API credential", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"domain\" : \"https://www.eu.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domain\" : \"https://www.eu.mystore.com\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -2854,63 +4055,64 @@ { "name": "Delete an allowed origin", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - }, - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -2918,63 +4120,64 @@ { "name": "Get an allowed origin", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - }, - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -2987,56 +4190,57 @@ { "name": "Get a list of billing entities", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/billingEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "billingEntities" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "name", - "value": "name_example", - "description": "The name of the billing entity.", - "disabled": true - } - ] - }, - "description": "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/billingEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "billingEntities" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example", + "description": "The name of the billing entity.", + "disabled": true + } + ] + }, + "description": "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3044,68 +4248,69 @@ { "name": "Get a list of shipping locations", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "shippingLocations" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "name", - "value": "name_example", - "description": "The name of the shipping location.", - "disabled": true - }, - { - "key": "offset", - "value": "56", - "description": "The number of locations to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of locations to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "shippingLocations" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example", + "description": "The name of the shipping location.", + "disabled": true + }, + { + "key": "offset", + "value": "56", + "description": "The number of locations to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of locations to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3113,56 +4318,115 @@ { "name": "Create a shipping location", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"NL\"\n },\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "shippingLocations" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-7973536B20662642215526704F302044452F714622375D476169\",\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n },\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"NL\"\n },\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "shippingLocations" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"NL\"\n },\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/shippingLocations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "shippingLocations" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -3170,50 +4434,51 @@ { "name": "Get a list of terminal models", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalModels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalModels" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalModels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalModels" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3221,74 +4486,75 @@ { "name": "Get a list of orders", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "customerOrderReference", - "value": "customerOrderReference_example", - "description": "Your purchase order number.", - "disabled": true - }, - { - "key": "status", - "value": "status_example", - "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", - "disabled": true - }, - { - "key": "offset", - "value": "56", - "description": "The number of orders to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of orders to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "customerOrderReference", + "value": "customerOrderReference_example", + "description": "Your purchase order number.", + "disabled": true + }, + { + "key": "status", + "value": "status_example", + "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", + "disabled": true + }, + { + "key": "offset", + "value": "56", + "description": "The number of orders to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of orders to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -3296,56 +4562,115 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"Company.YOUR_COMPANY\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"5265677890100681\",\n \"customerOrderReference\" : \"YOUR_REFERENCE\",\n \"status\" : \"Placed\",\n \"shippingLocation\" : {\n \"id\" : \"S2-232A6D2967356F424F4369432B3F486B6A6D\",\n \"name\" : \"YOUR_COMPANY HQ - POS Ops\",\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"email\" : \"Paul.Green@company.com\"\n },\n \"address\" : {\n \"streetAddress\" : \"Simon Carmiggeltstraat\",\n \"streetAddress2\" : \"6-50\",\n \"postalCode\" : \"1011 DJ\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n }\n },\n \"billingEntity\" : {\n \"id\" : \"Company.YOUR_COMPANY\",\n \"name\" : \"YOUR_COMPANY\",\n \"taxId\" : \"NL1234567890\",\n \"email\" : \"Paul.Green@company.com\",\n \"address\" : {\n \"streetAddress\" : \"Simon Carmiggeltstraat 6-50\",\n \"postalCode\" : \"1011 DJ\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n }\n },\n \"orderDate\" : \"2022-01-20T14:12:33Z\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"Company.YOUR_COMPANY\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"Company.YOUR_COMPANY\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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", @@ -3353,56 +4678,57 @@ { "name": "Get an order", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders", - ":orderId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3410,62 +4736,127 @@ { "name": "Update a terminal order", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 5\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"5265677890100681\",\n \"customerOrderReference\" : \"YOUR_REFERENCE_1\",\n \"status\" : \"Placed\",\n \"shippingLocation\" : {\n \"id\" : \"S2-7973536B20662642215526704F302044452F714622375D476169\",\n \"name\" : \"YOUR_COMPANY Rokin depot\",\n \"contact\" : {\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Green\",\n \"phoneNumber\" : \"+31 020 1234567\",\n \"email\" : \"Paul.Green@company.com\"\n },\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"Rokin 21\",\n \"postalCode\" : \"1012 KS\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"NL\"\n }\n },\n \"billingEntity\" : {\n \"id\" : \"Company.YOUR_COMPANY\",\n \"name\" : \"YOUR_COMPANY\",\n \"taxId\" : \"NL1234567890\",\n \"email\" : \"Paul.Green@company.com\",\n \"address\" : {\n \"streetAddress\" : \"Simon Carmiggeltstraat 6-50\",\n \"postalCode\" : \"1011 DJ\",\n \"city\" : \"Amsterdam\",\n \"country\" : \"NL\"\n }\n },\n \"orderDate\" : \"2022-01-20T14:12:33Z\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 5\n } ]\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 5\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-175746-EU\",\n \"name\" : \"Adyen Test Card\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 5\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders", - ":orderId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -3473,57 +4864,58 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalOrders", - ":orderId", - "cancel" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalOrders/:orderId/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalOrders", + ":orderId", + "cancel" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3531,74 +4923,75 @@ { "name": "Get a list of terminal products", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalProducts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalProducts" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "country", - "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", - "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", - "description": "The number of products to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of products to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalProducts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalProducts" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "country", + "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", + "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", + "description": "The number of products to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of products to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -3611,62 +5004,63 @@ { "name": "Get a list of API credentials", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. 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—API credentials read and write" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. 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—API credentials read and write" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3674,56 +5068,115 @@ { "name": "Add an API credential", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_API_CREDENTIAL\",\n \"username\" : \"YOUR_USERNAME\",\n \"clientKey\" : \"YOUR_CLIENT_KEY\",\n \"allowedIpAddresses\" : [ ],\n \"roles\" : [ \"Checkout webservice role\" ],\n \"active\" : true,\n \"allowedOrigins\" : [ {\n \"id\" : \"YOUR_ALLOWED_ORIGIN\",\n \"domain\" : \"https://www.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n } ],\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL\"\n },\n \"allowedOrigins\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins\"\n },\n \"generateApiKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey\"\n },\n \"generateClientKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey\"\n },\n \"merchant\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT\"\n }\n },\n \"apiKey\" : \"YOUR_API_KEY\",\n \"password\" : \"YOUR_PASSWORD\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -3731,56 +5184,57 @@ { "name": "Get an API credential", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -3788,62 +5242,127 @@ { "name": "Activate an API credential", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_API_CREDENTIAL\",\n \"username\" : \"YOUR_USERNAME\",\n \"clientKey\" : \"YOUR_CLIENT_KEY\",\n \"allowedIpAddresses\" : [ ],\n \"roles\" : [ \"Checkout webservice role\", \"Merchant PAL Webservice role\" ],\n \"active\" : true,\n \"allowedOrigins\" : [ {\n \"id\" : \"YOUR_ALLOWED_ORIGIN\",\n \"domain\" : \"https://www.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n } ],\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL\"\n },\n \"allowedOrigins\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins\"\n },\n \"generateApiKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey\"\n },\n \"generateClientKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey\"\n },\n \"merchant\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\" : true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/apiCredentials/:apiCredentialId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "apiCredentials", - ":apiCredentialId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -3856,68 +5375,69 @@ { "name": "Get a list of users", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "users" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "Unique identifier of the merchant." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The partial or complete username to select all users that match.", - "disabled": true - } - ] - }, - "description": "Returns a list of users associated with 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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The partial or complete username to select all users that match.", + "disabled": true + } + ] + }, + "description": "Returns a list of users associated with 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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -3925,56 +5445,115 @@ { "name": "Create a user", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-3B3C3C3B22\",\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"username\" : \"johnsmith\",\n \"roles\" : [ \"Merchant standard role\" ],\n \"active\" : true,\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/users/S2-3B3C3C3B22\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + } + ], + "query": [ + ] + }, + "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 " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"username\" : \"johnsmith\",\n \"email\" : \"john.smith@example.com\",\n \"timeZoneCode\" : \"Europe/Amsterdam\",\n \"roles\" : [ \"Merchant standard role\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/users", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "users" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "Unique identifier of the merchant." - } - ], - "query": [ - ] - }, - "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 " - } + ] } ] - } -, + }, { "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 ", @@ -3982,56 +5561,57 @@ { "name": "Get user details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/users/:userId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "users", - ":userId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "Unique identifier of the merchant." - }, - { - "key": "userId", - "value": "", - "description": "Unique identifier of the user." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users", + ":userId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + }, + { + "key": "userId", + "value": "", + "description": "Unique identifier of the user." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4039,62 +5619,63 @@ { "name": "Update a user", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/users/:userId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "users", - ":userId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "Unique identifier of the merchant." - }, - { - "key": "userId", - "value": "", - "description": "Unique identifier of the user." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/users/:userId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "users", + ":userId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "Unique identifier of the merchant." + }, + { + "key": "userId", + "value": "", + "description": "Unique identifier of the user." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] } - ] }, { @@ -4107,74 +5688,75 @@ { "name": "Get a list of terminal actions", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalActions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalActions" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "Returns terminal actions with the specified status. Allowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**.", - "disabled": true - }, - { - "key": "type", - "value": "type_example", - "description": "Returns terminal actions of the specified type. Allowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.", - "disabled": true - } - ] - }, - "description": "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalActions" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "Returns terminal actions with the specified status. Allowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**.", + "disabled": true + }, + { + "key": "type", + "value": "type_example", + "description": "Returns terminal actions of the specified type. Allowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.", + "disabled": true + } + ] + }, + "description": "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -4182,56 +5764,57 @@ { "name": "Get terminal action", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalActions/:actionId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalActions", - ":actionId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "actionId", - "value": "", - "description": "The unique identifier of the terminal action." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalActions/:actionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalActions", + ":actionId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "actionId", + "value": "", + "description": "The unique identifier of the terminal action." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -4244,74 +5827,75 @@ { "name": "Get all payment methods", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "storeId", - "value": "storeId_example", - "description": "The unique identifier of the store for which to return the payment methods.", - "disabled": true - }, - { - "key": "businessLineId", - "value": "businessLineId_example", - "description": "The unique identifier of the Business Line for which to return the payment methods.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The number of the page to fetch.", - "disabled": true - } - ] - }, - "description": "Returns details for all payment methods of 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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "storeId", + "value": "storeId_example", + "description": "The unique identifier of the store for which to return the payment methods.", + "disabled": true + }, + { + "key": "businessLineId", + "value": "businessLineId_example", + "description": "The unique identifier of the Business Line for which to return the payment methods.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The number of the page to fetch.", + "disabled": true + } + ] + }, + "description": "Returns details for all payment methods of 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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4319,106 +5903,225 @@ { "name": "Request a payment method", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"visa\",\n \"currencies\" : [ \"USD\" ],\n \"countries\" : [ \"US\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"PM3227C223224K5FH84M8CBNH\",\n \"type\" : \"visa\",\n \"countries\" : [ \"US\" ],\n \"currencies\" : [ \"USD\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"visa\",\n \"currencies\" : [ \"USD\" ],\n \"countries\" : [ \"US\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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 " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"visa\",\n \"currencies\" : [ \"USD\" ],\n \"countries\" : [ \"US\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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 " - } + ] }, { "name": "Request to add Swish", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessLineId\" : \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeId\" : \"ST322LJ223223K5F4SQNR9XL5\",\n \"type\" : \"swish\",\n \"swish\" : {\n \"swishNumber\" : \"1231111111\"\n },\n \"currencies\" : [ \"SEK\" ],\n \"countries\" : [ \"SE\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"PM3227C223224K5FH84M8CBNH\",\n \"businessLineId\" : \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeId\" : \"ST322LJ223223K5F4SQNR9XL5\",\n \"type\" : \"swish\",\n \"countries\" : [ \"SE\" ],\n \"currencies\" : [ \"SEK\" ],\n \"swish\" : {\n \"swishNumber\" : \"1231111111\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessLineId\" : \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeId\" : \"ST322LJ223223K5F4SQNR9XL5\",\n \"type\" : \"swish\",\n \"swish\" : {\n \"swishNumber\" : \"1231111111\"\n },\n \"currencies\" : [ \"SEK\" ],\n \"countries\" : [ \"SE\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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 " +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessLineId\" : \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeId\" : \"ST322LJ223223K5F4SQNR9XL5\",\n \"type\" : \"swish\",\n \"swish\" : {\n \"swishNumber\" : \"1231111111\"\n },\n \"currencies\" : [ \"SEK\" ],\n \"countries\" : [ \"SE\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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 " - } + ] } ] - } -, + }, { "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 ", @@ -4426,56 +6129,57 @@ { "name": "Get payment method details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings", - ":paymentMethodId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "paymentMethodId", - "value": "", - "description": "The unique identifier of the payment method." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings", + ":paymentMethodId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4483,62 +6187,63 @@ { "name": "Update a payment method", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bcmc\": \"\",\n \"cartesBancaires\": \"\",\n \"countries\": \"\",\n \"cup\": \"\",\n \"currencies\": \"\",\n \"customRoutingFlags\": \"\",\n \"diners\": \"\",\n \"discover\": \"\",\n \"eftpos_australia\": \"\",\n \"enabled\": \"\",\n \"girocard\": \"\",\n \"ideal\": \"\",\n \"interac_card\": \"\",\n \"jcb\": \"\",\n \"maestro\": \"\",\n \"mc\": \"\",\n \"storeIds\": \"\",\n \"visa\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings", - ":paymentMethodId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "paymentMethodId", - "value": "", - "description": "The unique identifier of the payment method." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bcmc\": \"\",\n \"cartesBancaires\": \"\",\n \"countries\": \"\",\n \"cup\": \"\",\n \"currencies\": \"\",\n \"customRoutingFlags\": \"\",\n \"diners\": \"\",\n \"discover\": \"\",\n \"eftpos_australia\": \"\",\n \"enabled\": \"\",\n \"girocard\": \"\",\n \"ideal\": \"\",\n \"interac_card\": \"\",\n \"jcb\": \"\",\n \"maestro\": \"\",\n \"mc\": \"\",\n \"storeIds\": \"\",\n \"visa\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings", + ":paymentMethodId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4546,63 +6251,64 @@ { "name": "Add an Apple Pay domain", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domains\" : [ \"https://example.com\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings", - ":paymentMethodId", - "addApplePayDomains" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "paymentMethodId", - "value": "", - "description": "The unique identifier of the payment method." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domains\" : [ \"https://example.com\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings", + ":paymentMethodId", + "addApplePayDomains" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] - } -, + }, { "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 ", @@ -4610,57 +6316,58 @@ { "name": "Get Apple Pay domains", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "paymentMethodSettings", - ":paymentMethodId", - "getApplePayDomains" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "paymentMethodId", - "value": "", - "description": "The unique identifier of the payment method." - } - ], - "query": [ - ] - }, - "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 " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "paymentMethodSettings", + ":paymentMethodId", + "getApplePayDomains" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "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 " +} + ,"response": [ + ] } ] } - ] }, { @@ -4673,43 +6380,44 @@ { "name": "Get API credential details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request. You can make this request with any of the Management API roles." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request. You can make this request with any of the Management API roles." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -4717,44 +6425,45 @@ { "name": "Get allowed origins", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "allowedOrigins" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -4762,50 +6471,51 @@ { "name": "Add allowed origin", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"_links\": \"\",\n \"domain\": \"\",\n \"id\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/allowedOrigins", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "allowedOrigins" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"_links\": \"\",\n \"domain\": \"\",\n \"id\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -4813,50 +6523,51 @@ { "name": "Remove allowed origin", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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." - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -4864,50 +6575,51 @@ { "name": "Get allowed origin details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/allowedOrigins/:originId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "allowedOrigins", - ":originId" - ], - "variable": [ - { - "key": "originId", - "value": "", - "description": "Unique identifier of the allowed origin." - } - ], - "query": [ - ] - }, - "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." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins/:originId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins", + ":originId" + ], + "variable": [ + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -4915,44 +6627,45 @@ { "name": "Generate a client key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/me/generateClientKey", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "me", - "generateClientKey" - ], - "variable": [ - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/generateClientKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "generateClientKey" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -4965,56 +6678,57 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "description": "Returns the logo that is configured for a specific payment terminal model at the merchant account 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 the specified model under the merchant account, unless a different logo is 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "description": "Returns the logo that is configured for a specific payment terminal model at the merchant account 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 the specified model under the merchant account, unless a different logo is 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5022,118 +6736,249 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -5141,50 +6986,51 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5192,106 +7038,225 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"nexoEventUrls\" : [ \"https://your-event-notifications-endpoint.com\" ]\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"nexoEventUrls\" : [ \"https://your-event-notifications-endpoint.com\" ]\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -5304,91 +7269,92 @@ { "name": "Get a list of terminals", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals" - ], - "variable": [ - ], - "query": [ - { - "key": "searchQuery", - "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", - "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", - "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", - "description": "Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.", - "disabled": true - }, - { - "key": "storeIds", - "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", - "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", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the payment terminals that the API credential has access to and that match 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 — Terminal actions read" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals" + ], + "variable": [ + ], + "query": [ + { + "key": "searchQuery", + "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", + "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", + "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", + "description": "Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.", + "disabled": true + }, + { + "key": "storeIds", + "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", + "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", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 20 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the payment terminals that the API credential has access to and that match 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 — Terminal actions read" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5396,56 +7362,57 @@ { "name": "Reassign a terminal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyId\": \"\",\n \"inventory\": \"\",\n \"merchantId\": \"\",\n \"storeId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/terminals/:terminalId/reassign", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "terminals", - ":terminalId", - "reassign" - ], - "variable": [ - { - "key": "terminalId", - "value": "", - "description": "The unique identifier of the payment terminal." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyId\": \"\",\n \"inventory\": \"\",\n \"merchantId\": \"\",\n \"storeId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/:terminalId/reassign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + ":terminalId", + "reassign" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -5458,62 +7425,63 @@ { "name": "List all webhooks", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Lists all webhook configurations for the company account. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Lists all webhook configurations for the company account. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5521,56 +7489,115 @@ { "name": "Add a webhook configuration", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"communicationFormat\" : \"soap\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false,\n \"filterMerchantAccountType\" : \"includeAccounts\",\n \"filterMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-6933523D2772\",\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"description\" : \"Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE\",\n \"filterMerchantAccountType\" : \"includeAccounts\",\n \"filterMerchantAccounts\" : [ \"YOUR_MERCHANT_ACCOUNT\" ],\n \"username\" : \"myuser\",\n \"hasPassword\" : true,\n \"active\" : true,\n \"hasError\" : false,\n \"communicationFormat\" : \"soap\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"certificateAlias\" : \"signed-test.adyen.com_2023\",\n \"populateSoapActionHeader\" : false,\n \"additionalSettings\" : {\n \"properties\" : {\n \"includePosTerminalInfo\" : false,\n \"includeARN\" : false,\n \"includePosDetails\" : false,\n \"includeCardInfoForRecurringContractNotification\" : false,\n \"includeRiskData\" : false,\n \"includeRiskExperimentReference\" : false,\n \"includeSoapSecurityHeader\" : false,\n \"includeContactlessWalletTokenInformation\" : false,\n \"includeAcquirerReference\" : false,\n \"includeRiskProfileReference\" : false,\n \"includeOriginalMerchantReferenceCancelOrRefundNotification\" : false,\n \"includeNfcTokenInformation\" : false,\n \"includeSubvariant\" : false,\n \"includeThreeDSVersion\" : false,\n \"includeInstallmentsInfo\" : false,\n \"includeAliasInfo\" : false,\n \"includeShopperCountry\" : false,\n \"includeRawThreeDSecureResult\" : false,\n \"includeAirlineData\" : false,\n \"includeGrossCurrencyChargebackDetails\" : false,\n \"includeThreeDSecureResult\" : false,\n \"includeMetadataIn3DSecurePaymentNotification\" : false,\n \"includeOriginalReferenceForChargebackReversed\" : false,\n \"addAcquirerResult\" : false,\n \"includeDeliveryAddress\" : false,\n \"includeRetryAttempts\" : false,\n \"includeExtraCosts\" : false,\n \"includeCardHolderName\" : false,\n \"includeShopperDetail\" : false,\n \"includeBankAccountDetails\" : false,\n \"includeMandateDetails\" : false,\n \"includeAuthAmountForDynamicZeroAuth\" : false,\n \"includeIssuerCountry\" : false,\n \"includeAcquirerErrorDetails\" : false,\n \"includeCoBrandedWith\" : false,\n \"includeShopperInteraction\" : false,\n \"includeDeviceAndBrowserInfo\" : false,\n \"addRawAcquirerResult\" : false,\n \"includeCardBin\" : false,\n \"includeFundingSource\" : false,\n \"includeThreeDS2ChallengeInformation\" : false,\n \"includeRiskProfile\" : false,\n \"includeRealtimeAccountUpdaterStatus\" : false,\n \"includeDunningProjectData\" : false,\n \"includePaymentResultInOrderClosedNotification\" : false,\n \"includeCardBinDetails\" : false,\n \"includeNotesInManualReviewNotifications\" : false,\n \"includeZeroAuthFlag\" : false,\n \"addCaptureReferenceToDisputeNotification\" : false,\n \"includePayPalDetails\" : false,\n \"includeRawThreeDSecureDetailsResult\" : false,\n \"includeBankVerificationResults\" : false,\n \"includeCaptureDelayHours\" : false,\n \"addPaymentAccountReference\" : false,\n \"includePayULatamDetails\" : false,\n \"includeStore\" : false,\n \"returnAvsData\" : false,\n \"includeWeChatPayOpenid\" : false,\n \"includeUpiVpa\" : false,\n \"includeCustomRoutingFlagging\" : false,\n \"includeTokenisedPaymentMetaData\" : false\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772\"\n },\n \"company\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT\"\n },\n \"generateHmac\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772/generateHmac\"\n },\n \"testWebhook\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772/test\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"communicationFormat\" : \"soap\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false,\n \"filterMerchantAccountType\" : \"includeAccounts\",\n \"filterMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"username\" : \"YOUR_USER\",\n \"password\" : \"YOUR_PASSWORD\",\n \"active\" : true,\n \"communicationFormat\" : \"soap\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : true,\n \"acceptsUntrustedRootCertificate\" : true,\n \"populateSoapActionHeader\" : false,\n \"filterMerchantAccountType\" : \"includeAccounts\",\n \"filterMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -5578,56 +7605,57 @@ { "name": "Remove a webhook", "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5635,56 +7663,57 @@ { "name": "Get a webhook", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5692,62 +7721,127 @@ { "name": "Activate the webhook", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-4A3B33202A46\",\n \"type\" : \"standard\",\n \"url\" : \"YOUR_WEBHOOK_URL\",\n \"description\" : \"Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE\",\n \"filterMerchantAccountType\" : \"allAccounts\",\n \"username\" : \"\",\n \"hasPassword\" : false,\n \"active\" : true,\n \"hasError\" : false,\n \"communicationFormat\" : \"json\",\n \"acceptsExpiredCertificate\" : false,\n \"acceptsSelfSignedCertificate\" : false,\n \"acceptsUntrustedRootCertificate\" : false,\n \"populateSoapActionHeader\" : false,\n \"additionalSettings\" : {\n \"properties\" : {\n \"includePosTerminalInfo\" : false,\n \"includeARN\" : false,\n \"includePosDetails\" : false,\n \"includeCardInfoForRecurringContractNotification\" : false,\n \"includeRiskData\" : false,\n \"includeRiskExperimentReference\" : false,\n \"includeSoapSecurityHeader\" : false,\n \"includeContactlessWalletTokenInformation\" : false,\n \"includeAcquirerReference\" : false,\n \"includeRiskProfileReference\" : false,\n \"includeOriginalMerchantReferenceCancelOrRefundNotification\" : false,\n \"includeNfcTokenInformation\" : false,\n \"includeSubvariant\" : false,\n \"includeThreeDSVersion\" : false,\n \"includeInstallmentsInfo\" : false,\n \"includeAliasInfo\" : false,\n \"includeShopperCountry\" : false,\n \"includeRawThreeDSecureResult\" : false,\n \"includeAirlineData\" : false,\n \"includeGrossCurrencyChargebackDetails\" : false,\n \"includeThreeDSecureResult\" : false,\n \"includeMetadataIn3DSecurePaymentNotification\" : false,\n \"includeOriginalReferenceForChargebackReversed\" : false,\n \"addAcquirerResult\" : false,\n \"includeDeliveryAddress\" : false,\n \"includeRetryAttempts\" : false,\n \"includeExtraCosts\" : false,\n \"includeCardHolderName\" : false,\n \"includeShopperDetail\" : false,\n \"includeBankAccountDetails\" : false,\n \"includeMandateDetails\" : false,\n \"includeAuthAmountForDynamicZeroAuth\" : false,\n \"includeIssuerCountry\" : false,\n \"includeAcquirerErrorDetails\" : false,\n \"includeCoBrandedWith\" : false,\n \"includeShopperInteraction\" : false,\n \"includeDeviceAndBrowserInfo\" : false,\n \"addRawAcquirerResult\" : false,\n \"includeCardBin\" : false,\n \"includeFundingSource\" : false,\n \"includeThreeDS2ChallengeInformation\" : false,\n \"includeRiskProfile\" : false,\n \"includeRealtimeAccountUpdaterStatus\" : false,\n \"includeDunningProjectData\" : false,\n \"includePaymentResultInOrderClosedNotification\" : false,\n \"includeCardBinDetails\" : false,\n \"includeNotesInManualReviewNotifications\" : false,\n \"includeZeroAuthFlag\" : false,\n \"addCaptureReferenceToDisputeNotification\" : false,\n \"includePayPalDetails\" : false,\n \"includeRawThreeDSecureDetailsResult\" : false,\n \"includeBankVerificationResults\" : false,\n \"includeCaptureDelayHours\" : false,\n \"addPaymentAccountReference\" : false,\n \"includePayULatamDetails\" : false,\n \"includeStore\" : false,\n \"returnAvsData\" : false,\n \"includeWeChatPayOpenid\" : false,\n \"includeUpiVpa\" : false,\n \"includeCustomRoutingFlagging\" : false,\n \"includeTokenisedPaymentMetaData\" : false\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46\"\n },\n \"company\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT\"\n },\n \"generateHmac\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/generateHmac\"\n },\n \"testWebhook\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/test\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\" : true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -5755,57 +7849,58 @@ { "name": "Generate an HMAC key", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/generateHmac", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId", - "generateHmac" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/generateHmac", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId", + "generateHmac" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5813,63 +7908,129 @@ { "name": "Test a webhook notification", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId", + "test" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : [ {\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_AU\",\n \"output\" : \"\",\n \"requestSent\" : \"{\\"live\\":\\"false\\",\\"notificationItems\\":[{\\"NotificationRequestItem\\":{\\"amount\\":{\\"currency\\":\\"EUR\\",\\"value\\":100},\\"eventCode\\":\\"AUTHORISATION\\",\\"eventDate\\":\\"2022-05-10T16:57:19+02:00\\",\\"merchantAccountCode\\":\\"YOUR_MERCHANT_ACCOUNT_AU\\",\\"merchantReference\\":\\"6GZBF5ML\\",\\"operations\\":[\\"CANCEL\\",\\"CAPTURE\\",\\"REFUND\\"],\\"paymentMethod\\":\\"visa\\",\\"pspReference\\":\\"KDN7UP7S1JIK6XES\\",\\"reason\\":\\"\\",\\"success\\":\\"true\\"}}]}\",\n \"responseCode\" : \"200\",\n \"responseTime\" : \"657 ms\",\n \"status\" : \"success\"\n }, {\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_EU\",\n \"output\" : \"\",\n \"requestSent\" : \"{\\"live\\":\\"false\\",\\"notificationItems\\":[{\\"NotificationRequestItem\\":{\\"amount\\":{\\"currency\\":\\"EUR\\",\\"value\\":100},\\"eventCode\\":\\"AUTHORISATION\\",\\"eventDate\\":\\"2022-05-10T16:57:19+02:00\\",\\"merchantAccountCode\\":\\"YOUR_MERCHANT_ACCOUNT_EU\\",\\"merchantReference\\":\\"6GZBF5ML\\",\\"operations\\":[\\"CANCEL\\",\\"CAPTURE\\",\\"REFUND\\"],\\"paymentMethod\\":\\"visa\\",\\"pspReference\\":\\"KDN7UP7S1JIK6XES\\",\\"reason\\":\\"\\",\\"success\\":\\"true\\"}}]}\",\n \"responseCode\" : \"200\",\n \"responseTime\" : \"590 ms\",\n \"status\" : \"success\"\n }, {\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_US\",\n \"output\" : \"\",\n \"requestSent\" : \"{\\"live\\":\\"false\\",\\"notificationItems\\":[{\\"NotificationRequestItem\\":{\\"amount\\":{\\"currency\\":\\"EUR\\",\\"value\\":100},\\"eventCode\\":\\"AUTHORISATION\\",\\"eventDate\\":\\"2022-05-10T16:57:19+02:00\\",\\"merchantAccountCode\\":\\"YOUR_MERCHANT_ACCOUNT_US\\",\\"merchantReference\\":\\"6GZBF5ML\\",\\"operations\\":[\\"CANCEL\\",\\"CAPTURE\\",\\"REFUND\\"],\\"paymentMethod\\":\\"visa\\",\\"pspReference\\":\\"KDN7UP7S1JIK6XES\\",\\"reason\\":\\"\\",\\"success\\":\\"true\\"}}]}\",\n \"responseCode\" : \"200\",\n \"responseTime\" : \"248 ms\",\n \"status\" : \"success\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "webhooks", + ":webhookId", + "test" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"notification\" : {\n \"paymentMethod\" : \"visa\",\n \"eventCode\" : \"AUTHORISATION\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2000\n },\n \"reason\" : \"Authorize visa payment\",\n \"success\" : true\n },\n \"types\" : [ \"CUSTOM\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/webhooks/:webhookId/test", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "webhooks", - ":webhookId", - "test" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "webhookId", - "value": "", - "description": "Unique identifier of the webhook configuration." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -5882,68 +8043,69 @@ { "name": "Get a list of stores", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The reference of the store.", - "disabled": true - } - ] - }, - "description": "Returns a list of stores for the merchant account identified in the path. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The reference of the store.", + "disabled": true + } + ] + }, + "description": "Returns a list of stores for the merchant account identified in the path. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -5951,56 +8113,115 @@ { "name": "Create a store under the merchant account specified in the path.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -6008,56 +8229,57 @@ { "name": "Get a store", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":storeId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6065,118 +8287,249 @@ { "name": "Update store address.", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20251\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":storeId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add split configuration to store", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20251\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n },\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":storeId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":storeId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -6184,67 +8537,68 @@ { "name": "Get a list of stores", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores" - ], - "variable": [ - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The reference of the store.", - "disabled": true - }, - { - "key": "merchantId", - "value": "merchantId_example", - "description": "The unique identifier of the merchant account.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores" + ], + "variable": [ + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The reference of the store.", + "disabled": true + }, + { + "key": "merchantId", + "value": "merchantId_example", + "description": "The unique identifier of the merchant account.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6252,49 +8606,101 @@ { "name": "Create a store", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantId\" : \"{{YOUR_MERCHANT_ACCOUNT}}_ID\",\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantId\" : \"{{YOUR_MERCHANT_ACCOUNT}}_ID\",\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores" + ], + "variable": [ + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantId\" : \"{{YOUR_MERCHANT_ACCOUNT}}_ID\",\n \"description\" : \"City centre store\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"200 Main Street\",\n \"line2\" : \"Building 5A\",\n \"line3\" : \"Suite 3\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20250\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores" - ], - "variable": [ - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -6302,49 +8708,50 @@ { "name": "Get a store", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6352,104 +8759,164 @@ { "name": "Update store address.", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_STORE_ID\",\n \"address\" : {\n \"country\" : \"US\",\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"city\" : \"Springfield\",\n \"stateOrProvince\" : \"NY\",\n \"postalCode\" : \"20251\"\n },\n \"description\" : \"City centre store\",\n \"merchantId\" : \"YOUR_MERCHANT_ACCOUNT_ID\",\n \"shopperStatement\" : \"Springfield Shop\",\n \"phoneNumber\" : \"+1813702551707653\",\n \"reference\" : \"Spring_store_2\",\n \"status\" : \"active\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/stores/YOUR_STORE_ID\"\n }\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"address\" : {\n \"line1\" : \"1776 West Pinewood Avenue\",\n \"line2\" : \"Heartland Building\",\n \"line3\" : \"\",\n \"postalCode\" : \"20251\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add split configuration to store", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"splitConfiguration\" : {\n \"balanceAccountId\" : \"BA3227C223222H5HQ2XX77VVH\",\n \"splitConfigurationId\" : \"SCNF4224P22322585HPCX384JV6JGX\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -6462,74 +8929,75 @@ { "name": "Get a list of Android apps", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/androidApps", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "androidApps" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The package name that uniquely identifies the Android app.", - "disabled": true - }, - { - "key": "versionCode", - "value": "56", - "description": "The version number of the app.", - "disabled": true - } - ] - }, - "description": "Returns a list of the Android apps that are available for the company 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 * Management API—Terminal actions read * Management API—Terminal actions read and write" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/androidApps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "androidApps" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The package name that uniquely identifies the Android app.", + "disabled": true + }, + { + "key": "versionCode", + "value": "56", + "description": "The version number of the app.", + "disabled": true + } + ] + }, + "description": "Returns a list of the Android apps that are available for the company 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 * Management API—Terminal actions read * Management API—Terminal actions read and write" +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -6537,50 +9005,51 @@ { "name": "Upload Android App", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/androidApps", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "androidApps" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/androidApps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "androidApps" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6588,56 +9057,57 @@ { "name": "Get Android app", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/androidApps/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "androidApps", - ":id" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "id", - "value": "", - "description": "The unique identifier of the app." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/androidApps/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "androidApps", + ":id" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "id", + "value": "", + "description": "The unique identifier of the app." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6645,68 +9115,69 @@ { "name": "Get a list of Android certificates", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/androidCertificates", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "androidCertificates" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "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", - "description": "The name of the certificate.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/androidCertificates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "androidCertificates" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "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", + "description": "The name of the certificate.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -6719,56 +9190,57 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalLogos" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "description": "Returns the logo that is configured for a specific payment terminal model at the company 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 the specified model under the company, unless a different logo is 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "description": "Returns the logo that is configured for a specific payment terminal model at the company 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 the specified model under the company, unless a different logo is 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6776,118 +9248,249 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalLogos" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalLogos" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -6895,50 +9498,51 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalSettings" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -6946,106 +9550,225 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalSettings" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "terminalSettings" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -7058,62 +9781,63 @@ { "name": "Get a list of API credentials", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. 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—API credentials read and write" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. 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—API credentials read and write" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7121,56 +9845,115 @@ { "name": "Add an API credential", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}_AU\", \"{{YOUR_MERCHANT_ACCOUNT}}_EU\", \"{{YOUR_MERCHANT_ACCOUNT}}_US\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_API_CREDENTIAL\",\n \"username\" : \"YOUR_USERNAME\",\n \"clientKey\" : \"YOUR_CLIENT_KEY\",\n \"allowedIpAddresses\" : [ ],\n \"roles\" : [ \"Checkout webservice role\" ],\n \"active\" : true,\n \"allowedOrigins\" : [ {\n \"id\" : \"YOUR_ALLOWED_ORIGIN\",\n \"domain\" : \"https://www.mystore.com\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN\"\n }\n }\n } ],\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL\"\n },\n \"allowedOrigins\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins\"\n },\n \"company\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT\"\n },\n \"generateApiKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey\"\n },\n \"generateClientKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey\"\n }\n },\n \"apiKey\" : \"YOUR_API_KEY\",\n \"password\" : \"YOUR_PASSWORD\",\n \"associatedMerchantAccounts\" : [ \"YOUR_MERCHANT_ACCOUNT_AU\", \"YOUR_MERCHANT_ACCOUNT_EU\", \"YOUR_MERCHANT_ACCOUNT_US\" ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}_AU\", \"{{YOUR_MERCHANT_ACCOUNT}}_EU\", \"{{YOUR_MERCHANT_ACCOUNT}}_US\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"roles\" : [ \"Checkout webservice role\" ],\n \"allowedOrigins\" : [ \"https://www.mystore.com\" ],\n \"associatedMerchantAccounts\" : [ \"{{YOUR_MERCHANT_ACCOUNT}}_AU\", \"{{YOUR_MERCHANT_ACCOUNT}}_EU\", \"{{YOUR_MERCHANT_ACCOUNT}}_US\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -7178,56 +9961,57 @@ { "name": "Get an API credential", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7235,62 +10019,127 @@ { "name": "Activate an API credential", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"YOUR_API_CREDENTIAL\",\n \"username\" : \"YOUR_USERNAME\",\n \"clientKey\" : \"YOUR_CLIENT_KEY\",\n \"allowedIpAddresses\" : [ ],\n \"roles\" : [ \"Management API - Accounts read\", \"Management API - Webhooks read\", \"Management API - API credentials read and write\", \"Management API - Stores read\", \"Management API — Payment methods read\", \"Management API - Stores read and write\", \"Management API - Webhooks read and write\", \"Merchant Recurring role\", \"Data Protection API\", \"Management API - Payout Account Settings Read\", \"Checkout webservice role\", \"Management API - Accounts read and write\", \"Merchant PAL Webservice role\" ],\n \"active\" : true,\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL\"\n },\n \"allowedOrigins\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins\"\n },\n \"company\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT\"\n },\n \"generateApiKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey\"\n },\n \"generateClientKey\" : {\n \"href\" : \"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey\"\n }\n },\n \"associatedMerchantAccounts\" : [ ]\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\" : true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "apiCredentials", + ":apiCredentialId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\" : true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/apiCredentials/:apiCredentialId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "apiCredentials", - ":apiCredentialId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - }, - { - "key": "apiCredentialId", - "value": "", - "description": "Unique identifier of the API credential." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] }, { @@ -7303,56 +10152,57 @@ { "name": "Get a list of billing entities", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/billingEntities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "billingEntities" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "name", - "value": "name_example", - "description": "The name of the billing entity.", - "disabled": true - } - ] - }, - "description": "Returns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/billingEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "billingEntities" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example", + "description": "The name of the billing entity.", + "disabled": true + } + ] + }, + "description": "Returns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7360,68 +10210,69 @@ { "name": "Get a list of shipping locations", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "shippingLocations" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "name", - "value": "name_example", - "description": "The name of the shipping location.", - "disabled": true - }, - { - "key": "offset", - "value": "56", - "description": "The number of locations to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of locations to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "shippingLocations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example", + "description": "The name of the shipping location.", + "disabled": true + }, + { + "key": "offset", + "value": "56", + "description": "The number of locations to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of locations to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7429,56 +10280,115 @@ { "name": "Create a shipping location", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : \"{{YOUR_MERCHANT_ACCOUNT}} Barcelona depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"ES\"\n },\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34 93 1234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "shippingLocations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"S2-73536B20665526704F30792642212044452F714622375D477270\",\n \"name\" : \"YOUR_MERCHANT_ACCOUNT Barcelona depot\",\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34931234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n },\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\" : \"{{YOUR_MERCHANT_ACCOUNT}} Barcelona depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"ES\"\n },\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34 93 1234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "shippingLocations" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\" : \"{{YOUR_MERCHANT_ACCOUNT}} Barcelona depot\",\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"ES\"\n },\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34 93 1234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/shippingLocations", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "shippingLocations" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -7486,50 +10396,51 @@ { "name": "Get a list of terminal models", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalModels", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalModels" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalModels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalModels" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7537,74 +10448,75 @@ { "name": "Get a list of orders", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "" - } - ], - "query": [ - { - "key": "customerOrderReference", - "value": "customerOrderReference_example", - "description": "Your purchase order number.", - "disabled": true - }, - { - "key": "status", - "value": "status_example", - "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", - "disabled": true - }, - { - "key": "offset", - "value": "56", - "description": "The number of orders to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of orders to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "" + } + ], + "query": [ + { + "key": "customerOrderReference", + "value": "customerOrderReference_example", + "description": "Your purchase order number.", + "disabled": true + }, + { + "key": "status", + "value": "status_example", + "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.", + "disabled": true + }, + { + "key": "offset", + "value": "56", + "description": "The number of orders to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of orders to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -7612,56 +10524,115 @@ { "name": "Create an order", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"MerchantAccount.{{YOUR_MERCHANT_ACCOUNT}}\",\n \"items\" : [ {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"4154567890100682\",\n \"customerOrderReference\" : \"YOUR_REFERENCE\",\n \"status\" : \"Placed\",\n \"shippingLocation\" : {\n \"id\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"name\" : \"YOUR_COMPANY Spain\",\n \"contact\" : {\n \"firstName\" : \"Pablo\",\n \"lastName\" : \"Mengano\",\n \"phoneNumber\" : \"+34911234567\",\n \"email\" : \"Pablo.Mengano@company.com\"\n },\n \"address\" : {\n \"streetAddress\" : \"Paseo de la Castellana 43\",\n \"streetAddress2\" : \"7 piso\",\n \"postalCode\" : \"28046\",\n \"city\" : \"Madrid\",\n \"country\" : \"ES\"\n }\n },\n \"billingEntity\" : {\n \"id\" : \"MerchantAccount.YOUR_MERCHANT_ACCOUNT\",\n \"name\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"taxId\" : \"ES1234567890\",\n \"email\" : \"Pablo.Mengano@company.com\",\n \"address\" : {\n \"streetAddress\" : \"Paseo de la Castellana 43, 7\",\n \"postalCode\" : \"28046\",\n \"city\" : \"Madrid\",\n \"country\" : \"ES\"\n }\n },\n \"orderDate\" : \"2022-01-21T16:12:33Z\",\n \"items\" : [ {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"MerchantAccount.{{YOUR_MERCHANT_ACCOUNT}}\",\n \"items\" : [ {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "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." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"customerOrderReference\" : \"{{$guid}}\",\n \"shippingLocationId\" : \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\" : \"MerchantAccount.{{YOUR_MERCHANT_ACCOUNT}}\",\n \"items\" : [ {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - ] - }, - "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." - } + ] } ] - } -, + }, { "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", @@ -7669,56 +10640,57 @@ { "name": "Get an order", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders", - ":orderId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7726,62 +10698,127 @@ { "name": "Update a terminal order", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"4154567890100682\",\n \"customerOrderReference\" : \"YOUR_REFERENCE\",\n \"status\" : \"Placed\",\n \"shippingLocation\" : {\n \"id\" : \"S2-73536B20665526704F30792642212044452F714622375D477270\",\n \"name\" : \"YOUR_MERCHANT_ACCOUNT Barcelona depot\",\n \"contact\" : {\n \"firstName\" : \"Rita\",\n \"lastName\" : \"Perengano\",\n \"phoneNumber\" : \"+34931234567\",\n \"email\" : \"Rita.Perengano@company.com\"\n },\n \"address\" : {\n \"companyName\" : \"YOUR_COMPANY\",\n \"streetAddress\" : \"El quinto pino 42\",\n \"postalCode\" : \"08012\",\n \"city\" : \"Barcelona\",\n \"stateOrProvince\" : \"\",\n \"country\" : \"ES\"\n }\n },\n \"billingEntity\" : {\n \"id\" : \"MerchantAccount.YOUR_MERCHANT_ACCOUNT\",\n \"name\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"taxId\" : \"ES1234567890\",\n \"email\" : \"Pablo.Mengano@company.com\",\n \"address\" : {\n \"streetAddress\" : \"Paseo de la Castellana 43, 7\",\n \"postalCode\" : \"28046\",\n \"city\" : \"Madrid\",\n \"country\" : \"ES\"\n }\n },\n \"orderDate\" : \"2022-01-21T16:12:33Z\",\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders", + ":orderId" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"items\" : [ {\n \"id\" : \"TBOX-V400m-684-EU\",\n \"name\" : \"V400m Package\",\n \"quantity\" : 1\n }, {\n \"id\" : \"PART-287001-EU\",\n \"name\" : \"Bluetooth Charging Base - V400m\",\n \"quantity\" : 2\n }, {\n \"id\" : \"PART-620222-EU\",\n \"name\" : \"Receipt Roll\",\n \"quantity\" : 20\n } ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders", - ":orderId" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -7789,57 +10826,58 @@ { "name": "Cancel an order", "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId/cancel", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalOrders", - ":orderId", - "cancel" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "orderId", - "value": "", - "description": "The unique identifier of the order." - } - ], - "query": [ - ] - }, - "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" - } + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalOrders/:orderId/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalOrders", + ":orderId", + "cancel" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7847,74 +10885,75 @@ { "name": "Get a list of terminal products", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/terminalProducts", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "terminalProducts" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - } - ], - "query": [ - { - "key": "country", - "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", - "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", - "description": "The number of products to skip.", - "disabled": true - }, - { - "key": "limit", - "value": "56", - "description": "The number of products to return.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/terminalProducts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "terminalProducts" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "country", + "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", + "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", + "description": "The number of products to skip.", + "disabled": true + }, + { + "key": "limit", + "value": "56", + "description": "The number of products to return.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -7927,55 +10966,56 @@ { "name": "Get a list of company accounts", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies" - ], - "variable": [ - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "description": "Returns the list of company 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies" + ], + "variable": [ + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "description": "Returns the list of company 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -7983,49 +11023,50 @@ { "name": "Get a company account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -8033,62 +11074,63 @@ { "name": "Get a list of merchant accounts", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/companies/:companyId/merchants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "companies", - ":companyId", - "merchants" - ], - "variable": [ - { - "key": "companyId", - "value": "{{YOUR_COMPANY_ACCOUNT}}", - "description": "The unique identifier of the company account." - } - ], - "query": [ - { - "key": "pageNumber", - "value": "56", - "description": "The number of the page to fetch.", - "disabled": true - }, - { - "key": "pageSize", - "value": "56", - "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", - "disabled": true - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/:companyId/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + ":companyId", + "merchants" + ], + "variable": [ + { + "key": "companyId", + "value": "{{YOUR_COMPANY_ACCOUNT}}", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56", + "description": "The number of the page to fetch.", + "disabled": true + }, + { + "key": "pageSize", + "value": "56", + "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page.", + "disabled": true + } + ] + }, + "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" +} + ,"response": [ + ] } ] } - ] }, { @@ -8101,63 +11143,64 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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 the specified 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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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 the specified 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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -8165,132 +11208,277 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalLogos" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -8298,57 +11486,58 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -8356,120 +11545,253 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + ":merchantId", + "stores", + ":reference", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "{{YOUR_MERCHANT_ACCOUNT}}", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/merchants/:merchantId/stores/:reference/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "merchants", - ":merchantId", - "stores", - ":reference", - "terminalSettings" - ], - "variable": [ - { - "key": "merchantId", - "value": "{{YOUR_MERCHANT_ACCOUNT}}", - "description": "The unique identifier of the merchant account." - }, - { - "key": "reference", - "value": "", - "description": "The reference that identifies the store." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -8477,56 +11799,57 @@ { "name": "Get the terminal logo", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalLogos" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -8534,118 +11857,249 @@ { "name": "Remove logo to restore the logo from a higher level", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalLogos" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] }, { "name": "Upload terminal logo", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"data\" : \"BASE-64_ENCODED_STRING_FROM_THE_REQUEST\"\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "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 + } + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"data\" : \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalLogos", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalLogos" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - { - "key": "model", - "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 - } - ] - }, - "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" - } + ] } ] - } -, + }, { "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", @@ -8653,50 +12107,51 @@ { "name": "Get terminal settings", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalSettings" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + ] } ] - } -, + }, { "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", @@ -8704,106 +12159,225 @@ { "name": "Add EAP-PEAP and PSK Wi-Fi profiles", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"peap\",\n \"eapCaCert\" : {\n \"data\" : \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\" : \"eap-peap-ca.pem\"\n },\n \"eapIdentity\" : \"admin\",\n \"eapIntermediateCert\" : {\n \"data\" : \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\" : \"eap-peap-client.pem\"\n },\n \"eapPwd\" : \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-peap-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n }, {\n \"authType\" : \"wpa-psk\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : false,\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-guest-wifi\",\n \"psk\" : \"WIFI_PASSWORD\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalSettings" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] }, { "name": "Add EAP-TLS Wi-Fi profile", "request": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"cardholderReceipt\" : {\n \"headerForAuthorizedReceipt\" : \"header1,header2,filler\"\n },\n \"gratuities\" : [ {\n \"currency\" : \"EUR\",\n \"usePredefinedTipEntries\" : true,\n \"predefinedTipEntries\" : [ \"100\", \"1%\", \"5%\" ],\n \"allowCustomAmount\" : true\n } ],\n \"nexo\" : {\n \"displayUrls\" : {\n \"localUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-display-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n },\n \"encryptionKey\" : {\n \"identifier\" : \"KEY_IDENTIFIER\",\n \"passphrase\" : \"KEY_PASSPHRASE\",\n \"version\" : 1\n },\n \"eventUrls\" : {\n \"eventPublicUrls\" : [ {\n \"password\" : \"BASIC_AUTH_PASSWORD\",\n \"url\" : \"https://your-event-notifications-endpoint.com\",\n \"username\" : \"BASIC_AUTH_USERNAME\"\n } ]\n }\n },\n \"opi\" : {\n \"enablePayAtTable\" : true,\n \"payAtTableStoreNumber\" : \"1\",\n \"payAtTableURL\" : \"https:/your-pay-at-table-endpoint.com\"\n },\n \"offlineProcessing\" : {\n \"chipFloorLimit\" : 0\n },\n \"receiptOptions\" : {\n \"qrCodeData\" : \"http://www.example.com/order/${pspreference}/${merchantreference}\"\n },\n \"receiptPrinting\" : {\n \"shopperApproved\" : true,\n \"shopperRefused\" : true,\n \"shopperCancelled\" : true,\n \"shopperRefundApproved\" : true,\n \"shopperRefundRefused\" : true,\n \"shopperVoid\" : true\n },\n \"signature\" : {\n \"askSignatureOnScreen\" : true,\n \"skipSignature\" : false,\n \"deviceName\" : \"Amsterdam-236203386\"\n },\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n },\n \"timeouts\" : {\n \"fromActiveToSleep\" : 30\n },\n \"hardware\" : {\n \"displayMaximumBackLight\" : 75\n }\n}", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + ":storeId", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "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" +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"wifiProfiles\" : {\n \"profiles\" : [ {\n \"authType\" : \"wpa-eap\",\n \"autoWifi\" : false,\n \"bssType\" : \"infra\",\n \"channel\" : 0,\n \"defaultProfile\" : true,\n \"eap\" : \"tls\",\n \"eapCaCert\" : {\n \"data\" : \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-ca.pem\"\n },\n \"eapClientCert\" : {\n \"data\" : \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\" : \"eap-tls-client.pem\"\n },\n \"eapClientKey\" : {\n \"data\" : \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\" : \"rsa-private.key\"\n },\n \"eapClientPwd\" : \"\",\n \"eapIdentity\" : \"admin\",\n \"hiddenSsid\" : false,\n \"name\" : \"Profile-eap-tls-1\",\n \"ssid\" : \"your-network\",\n \"wsec\" : \"ccmp\"\n } ],\n \"settings\" : {\n \"band\" : \"2.4GHz\",\n \"roaming\" : true,\n \"timeout\" : 5\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/stores/:storeId/terminalSettings", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "stores", - ":storeId", - "terminalSettings" - ], - "variable": [ - { - "key": "storeId", - "value": "", - "description": "The unique identifier of the store." - } - ], - "query": [ - ] - }, - "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" - } + ] } ] } - ] } ], diff --git a/postman/PayoutService-v30.json b/postman/PayoutService-v30.json index 5c31506..74aa491 100644 --- a/postman/PayoutService-v30.json +++ b/postman/PayoutService-v30.json @@ -19,49 +19,101 @@ { "name": "Store payout details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894326362D\",\n \"recurringDetailReference\" : \"9916178936754752\",\n \"resultCode\" : \"Success\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetail", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetail" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,230 @@ { "name": "Submit a payout and stores details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Neteller", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to PayPal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Paysafecard", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Skrill", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -291,49 +352,50 @@ { "name": "Submit a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/submitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "submitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -346,92 +408,95 @@ { "name": "Instant card payout (B2C)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] }, { "name": "Instant card payout (P2P)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] } ] } - ] }, { @@ -444,49 +509,101 @@ { "name": "Confirm a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325358C\",\n \"response\" : \"[payout-confirm-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/confirmThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "confirmThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." - } + ] } ] - } -, + }, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -494,49 +611,101 @@ { "name": "Cancel a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325360J\",\n \"response\" : \"[payout-decline-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/declineThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "declineThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." - } + ] } ] } - ] } ], diff --git a/postman/PayoutService-v40.json b/postman/PayoutService-v40.json index 45b9a8c..96696bf 100644 --- a/postman/PayoutService-v40.json +++ b/postman/PayoutService-v40.json @@ -19,49 +19,101 @@ { "name": "Store payout details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894326362D\",\n \"recurringDetailReference\" : \"9916178936754752\",\n \"resultCode\" : \"Success\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetail", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetail" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,230 @@ { "name": "Submit a payout and stores details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Neteller", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to PayPal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Paysafecard", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Skrill", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -291,49 +352,50 @@ { "name": "Submit a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/submitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "submitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -346,92 +408,95 @@ { "name": "Instant card payout (B2C)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] }, { "name": "Instant card payout (P2P)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] } ] } - ] }, { @@ -444,49 +509,101 @@ { "name": "Confirm a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325358C\",\n \"response\" : \"[payout-confirm-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/confirmThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "confirmThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." - } + ] } ] - } -, + }, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -494,49 +611,101 @@ { "name": "Cancel a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325360J\",\n \"response\" : \"[payout-decline-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/declineThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "declineThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." - } + ] } ] } - ] } ], diff --git a/postman/PayoutService-v50.json b/postman/PayoutService-v50.json index 4c71a27..4eead31 100644 --- a/postman/PayoutService-v50.json +++ b/postman/PayoutService-v50.json @@ -19,49 +19,101 @@ { "name": "Store payout details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894326362D\",\n \"recurringDetailReference\" : \"9916178936754752\",\n \"resultCode\" : \"Success\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetail", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetail" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,230 @@ { "name": "Submit a payout and stores details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Neteller", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to PayPal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Paysafecard", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Skrill", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -291,49 +352,50 @@ { "name": "Submit a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/submitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "submitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -346,92 +408,95 @@ { "name": "Instant card payout (B2C)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] }, { "name": "Instant card payout (P2P)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] } ] } - ] }, { @@ -444,49 +509,101 @@ { "name": "Confirm a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325358C\",\n \"response\" : \"[payout-confirm-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/confirmThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "confirmThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." - } + ] } ] - } -, + }, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -494,49 +611,101 @@ { "name": "Cancel a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325360J\",\n \"response\" : \"[payout-decline-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/declineThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "declineThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." - } + ] } ] } - ] } ], diff --git a/postman/PayoutService-v51.json b/postman/PayoutService-v51.json index 210494a..cfaa664 100644 --- a/postman/PayoutService-v51.json +++ b/postman/PayoutService-v51.json @@ -19,49 +19,101 @@ { "name": "Store payout details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894326362D\",\n \"recurringDetailReference\" : \"9916178936754752\",\n \"resultCode\" : \"Success\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetail", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetail" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,230 @@ { "name": "Submit a payout and stores details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Neteller", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to PayPal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Paysafecard", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Skrill", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -291,49 +352,50 @@ { "name": "Submit a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/submitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "submitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -346,92 +408,95 @@ { "name": "Instant card payout (B2C)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] }, { "name": "Instant card payout (P2P)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] } ] } - ] }, { @@ -444,49 +509,101 @@ { "name": "Confirm a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325358C\",\n \"response\" : \"[payout-confirm-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/confirmThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "confirmThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." - } + ] } ] - } -, + }, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -494,49 +611,101 @@ { "name": "Cancel a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325360J\",\n \"response\" : \"[payout-decline-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/declineThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "declineThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." - } + ] } ] } - ] } ], diff --git a/postman/PayoutService-v52.json b/postman/PayoutService-v52.json index 7dfc577..ef36d94 100644 --- a/postman/PayoutService-v52.json +++ b/postman/PayoutService-v52.json @@ -19,49 +19,101 @@ { "name": "Store payout details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894326362D\",\n \"recurringDetailReference\" : \"9916178936754752\",\n \"resultCode\" : \"Success\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetail", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetail" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,230 @@ { "name": "Submit a payout and stores details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Neteller", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to PayPal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Paysafecard", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Skrill", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -291,49 +352,50 @@ { "name": "Submit a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/submitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "submitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -346,92 +408,95 @@ { "name": "Instant card payout (B2C)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] }, { "name": "Instant card payout (P2P)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] } ] } - ] }, { @@ -444,49 +509,101 @@ { "name": "Confirm a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325358C\",\n \"response\" : \"[payout-confirm-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/confirmThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "confirmThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." - } + ] } ] - } -, + }, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -494,49 +611,101 @@ { "name": "Cancel a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325360J\",\n \"response\" : \"[payout-decline-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/declineThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "declineThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." - } + ] } ] } - ] } ], diff --git a/postman/PayoutService-v64.json b/postman/PayoutService-v64.json index 49fda66..e17de8f 100644 --- a/postman/PayoutService-v64.json +++ b/postman/PayoutService-v64.json @@ -19,49 +19,101 @@ { "name": "Store payout details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894326362D\",\n \"recurringDetailReference\" : \"9916178936754752\",\n \"resultCode\" : \"Success\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetail", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetail" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,230 @@ { "name": "Submit a payout and stores details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Neteller", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to PayPal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Paysafecard", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Skrill", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -291,49 +352,50 @@ { "name": "Submit a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/submitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "submitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -346,92 +408,95 @@ { "name": "Instant card payout (B2C)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] }, { "name": "Instant card payout (P2P)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] } ] } - ] }, { @@ -444,49 +509,101 @@ { "name": "Confirm a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325358C\",\n \"response\" : \"[payout-confirm-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/confirmThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "confirmThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." - } + ] } ] - } -, + }, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -494,49 +611,101 @@ { "name": "Cancel a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325360J\",\n \"response\" : \"[payout-decline-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/declineThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "declineThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." - } + ] } ] } - ] } ], diff --git a/postman/PayoutService-v67.json b/postman/PayoutService-v67.json index 6d46003..e38219b 100644 --- a/postman/PayoutService-v67.json +++ b/postman/PayoutService-v67.json @@ -19,49 +19,101 @@ { "name": "Store payout details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894326362D\",\n \"recurringDetailReference\" : \"9916178936754752\",\n \"resultCode\" : \"Success\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetail", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetail" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,230 @@ { "name": "Submit a payout and stores details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Neteller", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to PayPal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Paysafecard", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Skrill", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -291,49 +352,50 @@ { "name": "Submit a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/submitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "submitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -346,92 +408,95 @@ { "name": "Instant card payout (B2C)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] }, { "name": "Instant card payout (P2P)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] } ] } - ] }, { @@ -444,49 +509,101 @@ { "name": "Confirm a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325358C\",\n \"response\" : \"[payout-confirm-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/confirmThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "confirmThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." - } + ] } ] - } -, + }, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -494,49 +611,101 @@ { "name": "Cancel a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325360J\",\n \"response\" : \"[payout-decline-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/declineThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "declineThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." - } + ] } ] } - ] } ], diff --git a/postman/PayoutService-v68.json b/postman/PayoutService-v68.json index 8bd5ddb..aff7d1a 100644 --- a/postman/PayoutService-v68.json +++ b/postman/PayoutService-v68.json @@ -19,49 +19,101 @@ { "name": "Store payout details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894326362D\",\n \"recurringDetailReference\" : \"9916178936754752\",\n \"resultCode\" : \"Success\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"bank\" : {\n \"bankName\" : \"AbnAmro\",\n \"bic\" : \"ABNANL2A\",\n \"countryCode\" : \"NL\",\n \"iban\" : \"NL32ABNA0515071439\",\n \"ownerName\" : \"Adyen\",\n \"bankCity\" : \"Amsterdam\",\n \"taxId\" : \"bankTaxId\"\n },\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"17\",\n \"street\" : \"Teststreet 1\",\n \"city\" : \"Amsterdam\",\n \"stateOrProvince\" : \"NY\",\n \"country\" : \"US\",\n \"postalCode\" : \"12345\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetail", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetail" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." - } + ] } ] - } -, + }, { "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.", @@ -69,221 +121,230 @@ { "name": "Submit a payout and stores details", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n },\n \"bank\" : {\n \"bankName\" : \"Commerzbank\",\n \"iban\" : \"DE87123456781234567890\",\n \"countryCode\" : \"DE\",\n \"ownerName\" : \"Simon Hopper\"\n },\n \"reference\" : \"Your Reference\",\n \"shopperEmail\" : \"s.hopper@test.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Neteller", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"neteller\",\n \"additionalData\" : {\n \"tokenDataType\" : \"Neteller\",\n \"account\" : \"myNetellerAccount\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to PayPal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1750\n },\n \"selectedBrand\" : \"paypal\",\n \"additionalData\" : {\n \"tokenDataType\" : \"PayPal\",\n \"emailId\" : \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\" : \"AK5HCWWRUV2KL\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Paysafecard", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"selectedBrand\" : \"paysafecard\",\n \"additionalData\" : {\n \"emailId\" : \"EmailUsedForPaysafecardAccount@example.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Submit a payout to Skrill", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "storeDetailAndSubmitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 100\n },\n \"selectedBrand\" : \"moneybookers\",\n \"additionalData\" : {\n \"tokenDataType\" : \"MoneyBookers\",\n \"email\" : \"name@adyen.com\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Test\",\n \"lastName\" : \"Test2\"\n },\n \"dateOfBirth\" : \"1982-07-17\",\n \"entityType\" : \"NaturalPerson\",\n \"nationality\" : \"NL\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"Test Payout\",\n \"shopperEmail\" : \"test@company.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -291,49 +352,50 @@ { "name": "Submit a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/submitThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "submitThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\" : {\n \"contract\" : \"PAYOUT\"\n },\n \"reference\" : \"PayoutPayment-0001\",\n \"shopperEmail\" : \"shopper@email.com\",\n \"shopperReference\" : \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\" : {\n \"firstName\" : \"Adyen\",\n \"lastName\" : \"Test\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"entityType\" : \"Company\",\n \"nationality\" : \"NL\",\n \"selectedRecurringDetailReference\" : \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -346,92 +408,95 @@ { "name": "Instant card payout (B2C)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] }, { "name": "Instant card payout (P2P)", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/payout", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "payout" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 2500,\n \"currency\" : \"USD\"\n },\n \"card\" : {\n \"number\" : \"4111111111111111\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"fundSource\" : {\n \"additionalData\" : {\n \"fundingSource\" : \"DEBIT\"\n },\n \"billingAddress\" : {\n \"houseNumberOrName\" : \"121\",\n \"street\" : \"Brannan Street\",\n \"city\" : \"Beverly Hills\",\n \"postalCode\" : \"90210\",\n \"stateOrProvince\" : \"CA\",\n \"country\" : \"US\"\n },\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Payer Name\",\n \"number\" : \"4400000000000008\"\n },\n \"shopperName\" : {\n \"firstName\" : \"Payer\",\n \"lastName\" : \"Name\"\n }\n },\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"P9999999999999999\",\n \"shopperName\" : {\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\"\n },\n \"dateOfBirth\" : \"1990-01-01\",\n \"nationality\" : \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." +} + ,"response": [ + ] } ] } - ] }, { @@ -444,49 +509,101 @@ { "name": "Confirm a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325358C\",\n \"response\" : \"[payout-confirm-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/confirmThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "confirmThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." - } + ] } ] - } -, + }, { "name": "/declineThirdParty", "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", @@ -494,49 +611,101 @@ { "name": "Cancel a payout", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"pspReference\" : \"991617894325360J\",\n \"response\" : \"[payout-decline-received]\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\" : \"9913140798220028\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/declineThirdParty", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "declineThirdParty" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." - } + ] } ] } - ] } ], diff --git a/postman/RecurringService-v25.json b/postman/RecurringService-v25.json index c53834e..e317208 100644 --- a/postman/RecurringService-v25.json +++ b/postman/RecurringService-v25.json @@ -19,49 +19,50 @@ { "name": "Disable a recurring contract", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "disable" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -69,49 +70,50 @@ { "name": "List recurring details of the specified contract value", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/listRecurringDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "listRecurringDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -119,49 +121,101 @@ { "name": "Request issuer to notify shopper of upcoming recurring payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"message\" : \"Request Processed Successfully\",\n \"resultCode\" : \"Success\",\n \"shopperNotificationReference\" : \"9915003646742627\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"pspReference\" : \"M5N7TQ4TG5PFWR50\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/notifyShopper", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "notifyShopper" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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.", @@ -169,92 +223,95 @@ { "name": "Schedule AccountUpdater with card data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Schedule AccountUpdater with token data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/RecurringService-v30.json b/postman/RecurringService-v30.json index 0ea0bb7..d0919f7 100644 --- a/postman/RecurringService-v30.json +++ b/postman/RecurringService-v30.json @@ -19,49 +19,50 @@ { "name": "Disable a recurring contract", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "disable" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -69,49 +70,50 @@ { "name": "List recurring details of the specified contract value", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/listRecurringDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "listRecurringDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -119,49 +121,101 @@ { "name": "Request issuer to notify shopper of upcoming recurring payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"message\" : \"Request Processed Successfully\",\n \"resultCode\" : \"Success\",\n \"shopperNotificationReference\" : \"9915003646742627\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"pspReference\" : \"M5N7TQ4TG5PFWR50\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/notifyShopper", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "notifyShopper" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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.", @@ -169,92 +223,95 @@ { "name": "Schedule AccountUpdater with card data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Schedule AccountUpdater with token data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/RecurringService-v40.json b/postman/RecurringService-v40.json index 416245b..2a83ccf 100644 --- a/postman/RecurringService-v40.json +++ b/postman/RecurringService-v40.json @@ -19,49 +19,50 @@ { "name": "Create new permits linked to a recurring contract.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/createPermit", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "createPermit" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Create permits for a recurring contract, including support for defining restrictions." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createPermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createPermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Create permits for a recurring contract, including support for defining restrictions." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -69,49 +70,50 @@ { "name": "Disable a recurring contract", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "disable" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -119,49 +121,50 @@ { "name": "List recurring details of the specified contract value", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/listRecurringDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "listRecurringDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -169,49 +172,101 @@ { "name": "Request issuer to notify shopper of upcoming recurring payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"message\" : \"Request Processed Successfully\",\n \"resultCode\" : \"Success\",\n \"shopperNotificationReference\" : \"9915003646742627\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"pspReference\" : \"M5N7TQ4TG5PFWR50\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/notifyShopper", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "notifyShopper" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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.", @@ -219,92 +274,95 @@ { "name": "Schedule AccountUpdater with card data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Schedule AccountUpdater with token data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/RecurringService-v49.json b/postman/RecurringService-v49.json index c84fedf..e45fe27 100644 --- a/postman/RecurringService-v49.json +++ b/postman/RecurringService-v49.json @@ -19,49 +19,50 @@ { "name": "Create new permits linked to a recurring contract.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/createPermit", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "createPermit" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Create permits for a recurring contract, including support for defining restrictions." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createPermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createPermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Create permits for a recurring contract, including support for defining restrictions." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -69,49 +70,50 @@ { "name": "Disable a recurring contract", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "disable" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -119,49 +121,50 @@ { "name": "List recurring details of the specified contract value", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/listRecurringDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "listRecurringDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -169,49 +172,101 @@ { "name": "Request issuer to notify shopper of upcoming recurring payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"message\" : \"Request Processed Successfully\",\n \"resultCode\" : \"Success\",\n \"shopperNotificationReference\" : \"9915003646742627\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"pspReference\" : \"M5N7TQ4TG5PFWR50\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/notifyShopper", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "notifyShopper" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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.", @@ -219,92 +274,95 @@ { "name": "Schedule AccountUpdater with card data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Schedule AccountUpdater with token data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/RecurringService-v67.json b/postman/RecurringService-v67.json index 5687a45..f4839a8 100644 --- a/postman/RecurringService-v67.json +++ b/postman/RecurringService-v67.json @@ -19,49 +19,50 @@ { "name": "Create new permits linked to a recurring contract.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/createPermit", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "createPermit" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Create permits for a recurring contract, including support for defining restrictions." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createPermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createPermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Create permits for a recurring contract, including support for defining restrictions." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -69,49 +70,50 @@ { "name": "Disable a recurring contract", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "disable" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/disablePermit", "description": "Disable a permit that was previously linked to a recurringDetailReference.", @@ -119,49 +121,50 @@ { "name": "Disable an existing permit.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"token\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/disablePermit", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "disablePermit" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Disable a permit that was previously linked to a recurringDetailReference." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"token\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disablePermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disablePermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disable a permit that was previously linked to a recurringDetailReference." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -169,49 +172,50 @@ { "name": "List recurring details of the specified contract value", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/listRecurringDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "listRecurringDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -219,49 +223,101 @@ { "name": "Request issuer to notify shopper of upcoming recurring payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"message\" : \"Request Processed Successfully\",\n \"resultCode\" : \"Success\",\n \"shopperNotificationReference\" : \"9915003646742627\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"pspReference\" : \"M5N7TQ4TG5PFWR50\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/notifyShopper", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "notifyShopper" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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.", @@ -269,92 +325,95 @@ { "name": "Schedule AccountUpdater with card data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Schedule AccountUpdater with token data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/RecurringService-v68.json b/postman/RecurringService-v68.json index 79fe1fc..50c780d 100644 --- a/postman/RecurringService-v68.json +++ b/postman/RecurringService-v68.json @@ -19,49 +19,50 @@ { "name": "Create new permits linked to a recurring contract.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/createPermit", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "createPermit" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Create permits for a recurring contract, including support for defining restrictions." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createPermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createPermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Create permits for a recurring contract, including support for defining restrictions." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -69,49 +70,50 @@ { "name": "Disable a recurring contract", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/disable", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "disable" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"recurringDetailReference\" : \"8314442372419167\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/disablePermit", "description": "Disable a permit that was previously linked to a recurringDetailReference.", @@ -119,49 +121,50 @@ { "name": "Disable an existing permit.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"token\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/disablePermit", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "disablePermit" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Disable a permit that was previously linked to a recurringDetailReference." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"token\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disablePermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disablePermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disable a permit that was previously linked to a recurringDetailReference." +} + ,"response": [ + ] } ] - } -, + }, { "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/).", @@ -169,49 +172,50 @@ { "name": "List recurring details of the specified contract value", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/listRecurringDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "listRecurringDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "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/)." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\" : {\n \"contract\" : \"RECURRING\"\n },\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "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/)." +} + ,"response": [ + ] } ] - } -, + }, { "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).", @@ -219,49 +223,101 @@ { "name": "Request issuer to notify shopper of upcoming recurring payment", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"message\" : \"Request Processed Successfully\",\n \"resultCode\" : \"Success\",\n \"shopperNotificationReference\" : \"9915003646742627\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"pspReference\" : \"M5N7TQ4TG5PFWR50\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "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)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\" : \"8415995487234100\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"amount\" : {\n \"currency\" : \"INR\",\n \"value\" : 1000\n },\n \"billingDate\" : \"2021-03-16\",\n \"reference\" : \"Example reference\",\n \"displayedReference\" : \"exampleDisplayedReference\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/notifyShopper", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "notifyShopper" - ], - "variable": [ - ], - "query": [ - ] - }, - "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)." - } + ] } ] - } -, + }, { "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.", @@ -269,92 +325,95 @@ { "name": "Schedule AccountUpdater with card data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"card\" : {\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"Adyen Test\",\n \"number\" : \"4111111111111111\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] }, { "name": "Schedule AccountUpdater with token data", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/scheduleAccountUpdater", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "scheduleAccountUpdater" - ], - "variable": [ - ], - "query": [ - ] - }, - "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." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\" : \"{{$guid}}\",\n \"shopperReference\" : \"YOUR_SHOPPER_REFERENCE\",\n \"selectedRecurringDetailReference\" : \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/StoredValueService-v46.json b/postman/StoredValueService-v46.json index 455d745..61c3475 100644 --- a/postman/StoredValueService-v46.json +++ b/postman/StoredValueService-v46.json @@ -19,49 +19,50 @@ { "name": "Changes the status of the payment method.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"status\": \"\",\n \"store\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/changeStatus", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "changeStatus" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Changes the status of the provided payment method to the specified status." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"status\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/changeStatus", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "changeStatus" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Changes the status of the provided payment method to the specified status." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/checkBalance", "description": "Checks the balance of the provided payment method.", @@ -69,49 +70,50 @@ { "name": "Checks the balance.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"store\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/checkBalance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "checkBalance" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Checks the balance of the provided payment method." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/checkBalance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "checkBalance" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Checks the balance of the provided payment method." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/issue", "description": "Issues a new card of the given payment method.", @@ -119,49 +121,50 @@ { "name": "Issues a new card.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"store\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/issue", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "issue" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Issues a new card of the given payment method." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/issue", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "issue" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Issues a new card of the given payment method." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/load", "description": "Loads the payment method with the specified funds.", @@ -169,49 +172,50 @@ { "name": "Loads the payment method.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"loadType\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"store\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/load", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "load" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Loads the payment method with the specified funds." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"loadType\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/load", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "load" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Loads the payment method with the specified funds." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/mergeBalance", "description": "Increases the balance of the paymentmethod by the full amount left on the source paymentmethod", @@ -219,49 +223,50 @@ { "name": "Merge the balance of two cards.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"sourcePaymentMethod\": \"\",\n \"store\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/mergeBalance", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "mergeBalance" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Increases the balance of the paymentmethod by the full amount left on the source paymentmethod" - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"sourcePaymentMethod\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/mergeBalance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "mergeBalance" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Increases the balance of the paymentmethod by the full amount left on the source paymentmethod" +} + ,"response": [ + ] } ] - } -, + }, { "name": "/voidTransaction", "description": "Voids the referenced stored value transaction.", @@ -269,49 +274,50 @@ { "name": "Voids a transaction.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"originalReference\": \"\",\n \"reference\": \"\",\n \"store\": \"\",\n \"tenderReference\": \"\",\n \"uniqueTerminalId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/voidTransaction", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "voidTransaction" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Voids the referenced stored value transaction." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"originalReference\": \"\",\n \"reference\": \"\",\n \"store\": \"\",\n \"tenderReference\": \"\",\n \"uniqueTerminalId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/voidTransaction", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "voidTransaction" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Voids the referenced stored value transaction." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/TestCardService-v1.json b/postman/TestCardService-v1.json index d703172..d2690f7 100644 --- a/postman/TestCardService-v1.json +++ b/postman/TestCardService-v1.json @@ -19,49 +19,50 @@ { "name": "Creates one or more test card ranges.", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"accountCode\": \"\",\n \"accountTypeCode\": \"\",\n \"testCardRanges\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/createTestCardRanges", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "createTestCardRanges" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Creates one or more test card ranges." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountCode\": \"\",\n \"accountTypeCode\": \"\",\n \"testCardRanges\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createTestCardRanges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createTestCardRanges" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates one or more test card ranges." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/TfmAPIService-v1.json b/postman/TfmAPIService-v1.json index cde87b5..bf632c5 100644 --- a/postman/TfmAPIService-v1.json +++ b/postman/TfmAPIService-v1.json @@ -19,135 +19,293 @@ { "name": "Assign a terminal to the company inventory", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"terminals\" : [ \"P400Plus-275479597\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/assignTerminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "assignTerminals" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"results\" : {\n \"P400Plus-275479597\" : \"RemoveConfigScheduled\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"terminals\" : [ \"P400Plus-275479597\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/assignTerminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "assignTerminals" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"terminals\" : [ \"P400Plus-275479597\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/assignTerminals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "assignTerminals" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." - } + ] }, { "name": "Assign a terminal to the inventory of a merchant account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantInventory\" : true,\n \"terminals\" : [ \"P400Plus-275479597\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/assignTerminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "assignTerminals" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"results\" : {\n \"P400Plus-275479597\" : \"RemoveConfigScheduled\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantInventory\" : true,\n \"terminals\" : [ \"P400Plus-275479597\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/assignTerminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "assignTerminals" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantInventory\" : true,\n \"terminals\" : [ \"P400Plus-275479597\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/assignTerminals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "assignTerminals" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." - } + ] }, { "name": "Assign a terminal to a store", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\" : \"YOUR_STORE\",\n \"terminals\" : [ \"P400Plus-275479597\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/assignTerminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "assignTerminals" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"results\" : {\n \"P400Plus-275479597\" : \"RemoveConfigScheduled\"\n }\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\" : \"YOUR_STORE\",\n \"terminals\" : [ \"P400Plus-275479597\" ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/assignTerminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "assignTerminals" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\" : \"YOUR_STORE\",\n \"terminals\" : [ \"P400Plus-275479597\" ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/assignTerminals", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "assignTerminals" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." - } + ] } ] - } -, + }, { "name": "/findTerminal", "description": "Returns the company account, merchant account, or store that a payment terminal is assigned to.", @@ -155,49 +313,101 @@ { "name": "Find where a terminal is assigned to", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminal\" : \"M400-401972715\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/findTerminal", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "findTerminal" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns the company account, merchant account, or store that a payment terminal is assigned to." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"companyAccount\" : \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"merchantInventory\" : false,\n \"store\" : \"YOUR_STORE\",\n \"terminal\" : \"M400-401972715\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminal\" : \"M400-401972715\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/findTerminal", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "findTerminal" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns the company account, merchant account, or store that a payment terminal is assigned to." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"terminal\" : \"M400-401972715\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/findTerminal", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "findTerminal" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns the company account, merchant account, or store that a payment terminal is assigned to." - } + ] } ] - } -, + }, { "name": "/getStoresUnderAccount", "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store.", @@ -205,92 +415,197 @@ { "name": "Get all the stores under a company", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getStoresUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getStoresUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"stores\" : [ {\n \"store\" : \"YOUR_STORE\",\n \"description\" : \"YOUR_STORE\",\n \"address\" : {\n \"city\" : \"The City\",\n \"countryCode\" : \"NL\",\n \"postalCode\" : \"1234\",\n \"streetAddress\" : \"The Street\"\n },\n \"status\" : \"Active\",\n \"merchantAccountCode\" : \"YOUR_MERCHANT_ACCOUNT\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getStoresUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getStoresUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getStoresUnderAccount", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getStoresUnderAccount" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store." - } + ] }, { "name": "Get all the stores under a merchant account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getStoresUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getStoresUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"stores\" : [ {\n \"store\" : \"YOUR_STORE\",\n \"description\" : \"YOUR_STORE\",\n \"address\" : {\n \"city\" : \"The City\",\n \"countryCode\" : \"NL\",\n \"postalCode\" : \"1234\",\n \"streetAddress\" : \"The Street\"\n },\n \"status\" : \"Active\",\n \"merchantAccountCode\" : \"YOUR_MERCHANT_ACCOUNT\"\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getStoresUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getStoresUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getStoresUnderAccount", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getStoresUnderAccount" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store." - } + ] } ] - } -, + }, { "name": "/getTerminalDetails", "description": "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report.", @@ -298,49 +613,101 @@ { "name": "Get information about a specific terminal", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminal\" : \"M400-401972715\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"companyAccount\" : \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"merchantInventory\" : false,\n \"store\" : \"YOUR_STORE\",\n \"terminal\" : \"M400-401972715\",\n \"deviceModel\" : \"M400\",\n \"serialNumber\" : \"401-972-715\",\n \"permanentTerminalId\" : \"88912016\",\n \"terminalStatus\" : \"SwitchedOff\",\n \"firmwareVersion\" : \"Verifone_VOS 1.57.6\",\n \"country\" : \"NETHERLANDS\",\n \"storeDetails\" : {\n \"store\" : \"YOUR_STORE\",\n \"description\" : \"TestStore\",\n \"address\" : {\n \"city\" : \"The City\",\n \"countryCode\" : \"NL\",\n \"postalCode\" : \"1234\",\n \"streetAddress\" : \"The Street\"\n }\n },\n \"ethernetMac\" : \"60:c7:98:5a:69:cd\",\n \"ethernetIp\" : \"192.168.2.11\",\n \"wifiMac\" : \"c4:ac:59:47:f3:71\",\n \"wifiIp\" : \"192.168.2.12\",\n \"dhcpEnabled\" : false\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminal\" : \"M400-401972715\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"terminal\" : \"M400-401972715\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getTerminalDetails", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getTerminalDetails" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report." - } + ] } ] - } -, + }, { "name": "/getTerminalsUnderAccount", "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded).", @@ -348,135 +715,293 @@ { "name": "Get all the terminals under a company account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalsUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalsUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"companyAccount\" : \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccounts\" : [ {\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"inStoreTerminals\" : [ \"P400Plus-275479597\" ],\n \"stores\" : [ {\n \"store\" : \"YOUR_STORE\",\n \"inStoreTerminals\" : [ \"M400-401972715\" ]\n } ]\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalsUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalsUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getTerminalsUnderAccount", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getTerminalsUnderAccount" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." - } + ] }, { "name": "Get all the terminals under a merchant account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalsUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalsUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"companyAccount\" : \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccounts\" : [ {\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"inStoreTerminals\" : [ \"P400Plus-275479597\" ],\n \"stores\" : [ {\n \"store\" : \"YOUR_STORE\",\n \"inStoreTerminals\" : [ \"M400-401972715\" ]\n } ]\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalsUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalsUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getTerminalsUnderAccount", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getTerminalsUnderAccount" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." - } + ] }, { "name": "Get all the terminals assigned to a store", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\" : \"YOUR_STORE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalsUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalsUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"companyAccount\" : \"YOUR_COMPANY_ACCOUNT\",\n \"merchantAccounts\" : [ {\n \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n \"stores\" : [ {\n \"store\" : \"YOUR_STORE\",\n \"inStoreTerminals\" : [ \"M400-401972715\" ]\n } ]\n } ]\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\" : \"YOUR_STORE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalsUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalsUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"companyAccount\" : \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\" : \"YOUR_STORE\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/getTerminalsUnderAccount", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "getTerminalsUnderAccount" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." - } + ] } ] } - ] } ], diff --git a/postman/TransferService-v1.json b/postman/TransferService-v1.json index 2f887c4..b596e1c 100644 --- a/postman/TransferService-v1.json +++ b/postman/TransferService-v1.json @@ -19,91 +19,92 @@ { "name": "Get all transactions", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactions" - ], - "variable": [ - ], - "query": [ - { - "key": "balancePlatform", - "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", - "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", - "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", - "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", - "description": "The `cursor` returned in the links of the previous response.", - "disabled": true - }, - { - "key": "createdSince", - "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", - "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", - "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions" + ], + "variable": [ + ], + "query": [ + { + "key": "balancePlatform", + "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", + "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", + "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", + "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", + "description": "The `cursor` returned in the links of the previous response.", + "disabled": true + }, + { + "key": "createdSince", + "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", + "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", + "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. " +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -111,49 +112,50 @@ { "name": "Get a transaction", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactions/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactions", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transaction." - } - ], - "query": [ - ] - }, - "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." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transaction." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -166,104 +168,221 @@ { "name": "Transfer funds to another balance account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"source\" : {\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n },\n \"destination\" : {\n \"balanceAccountId\" : \"BAB1234567890ABC123456789\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"source\" : {\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n },\n \"destination\" : {\n \"balanceAccountId\" : \"BAB1234567890ABC123456789\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"source\" : {\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n },\n \"destination\" : {\n \"balanceAccountId\" : \"BAB1234567890ABC123456789\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"source\" : {\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n },\n \"destination\" : {\n \"balanceAccountId\" : \"BAB1234567890ABC123456789\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Pay out to a transfer instrument", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"source\" : {\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n },\n \"destination\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"source\" : {\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n },\n \"destination\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"resultCode\" : \"Authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"source\" : {\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n },\n \"destination\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"source\" : {\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n },\n \"destination\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] } ] } - ] } ], diff --git a/postman/TransferService-v2.json b/postman/TransferService-v2.json index 1986067..7c191f2 100644 --- a/postman/TransferService-v2.json +++ b/postman/TransferService-v2.json @@ -19,91 +19,92 @@ { "name": "Get all transactions", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactions" - ], - "variable": [ - ], - "query": [ - { - "key": "balancePlatform", - "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", - "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", - "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", - "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", - "description": "The `cursor` returned in the links of the previous response.", - "disabled": true - }, - { - "key": "createdSince", - "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", - "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", - "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions" + ], + "variable": [ + ], + "query": [ + { + "key": "balancePlatform", + "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", + "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", + "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", + "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", + "description": "The `cursor` returned in the links of the previous response.", + "disabled": true + }, + { + "key": "createdSince", + "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", + "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", + "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. " +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -111,49 +112,50 @@ { "name": "Get a transaction", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactions/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactions", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transaction." - } - ], - "query": [ - ] - }, - "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." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transaction." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -166,153 +168,329 @@ { "name": "Make a SEPA funds transfer", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"iban\" : \"NL13TEST0123456789\",\n \"ownerName\" : {\n \"fullName\" : \"A. Klaassen\"\n }\n }\n },\n \"bank\" : {\n \"priority\" : \"regular\"\n },\n \"referenceForBeneficiary\" : \"Your reference sent to the beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"iban\" : \"NL13TEST0123456789\",\n \"ownerName\" : {\n \"fullName\" : \"A. Klaassen\"\n }\n }\n },\n \"bank\" : {\n \"priority\" : \"regular\"\n },\n \"referenceForBeneficiary\" : \"Your reference sent to the beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"iban\" : \"NL13TEST0123456789\",\n \"ownerName\" : {\n \"fullName\" : \"A. Klaassen\"\n }\n }\n },\n \"bank\" : {\n \"priority\" : \"regular\"\n },\n \"referenceForBeneficiary\" : \"Your reference sent to the beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"iban\" : \"NL13TEST0123456789\",\n \"ownerName\" : {\n \"fullName\" : \"A. Klaassen\"\n }\n }\n },\n \"bank\" : {\n \"priority\" : \"regular\"\n },\n \"referenceForBeneficiary\" : \"Your reference sent to the beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Transfer funds to another balance account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BAB1234567890ABC123456789\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32272223222B5LPRFDW7J9G\"\n },\n \"referenceForBeneficiary\" : \"Your reference sent to the beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BAB1234567890ABC123456789\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BAB1234567890ABC123456789\"\n },\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Pay out to a transfer instrument", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"bank\" : {\n \"priority\" : \"regular\"\n },\n \"referenceForBeneficiary\" : \"Your reference sent to the beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"bank\" : {\n \"priority\" : \"regular\"\n },\n \"referenceForBeneficiary\" : \"Your reference sent to the beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"bank\" : {\n \"priority\" : \"regular\"\n },\n \"referenceForBeneficiary\" : \"Your reference sent to the beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"bank\" : {\n \"priority\" : \"regular\"\n },\n \"referenceForBeneficiary\" : \"Your reference sent to the beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] } ] } - ] } ], diff --git a/postman/TransferService-v3.json b/postman/TransferService-v3.json index 0e4d630..eacc038 100644 --- a/postman/TransferService-v3.json +++ b/postman/TransferService-v3.json @@ -19,91 +19,92 @@ { "name": "Get all transactions", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactions" - ], - "variable": [ - ], - "query": [ - { - "key": "balancePlatform", - "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", - "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", - "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", - "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", - "description": "The `cursor` returned in the links of the previous response.", - "disabled": true - }, - { - "key": "createdSince", - "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", - "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", - "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions" + ], + "variable": [ + ], + "query": [ + { + "key": "balancePlatform", + "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", + "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", + "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", + "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", + "description": "The `cursor` returned in the links of the previous response.", + "disabled": true + }, + { + "key": "createdSince", + "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", + "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", + "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. " +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -111,49 +112,50 @@ { "name": "Get a transaction", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactions/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactions", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transaction." - } - ], - "query": [ - ] - }, - "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." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transaction." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -166,251 +168,545 @@ { "name": "Make a cross-border transfer", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\",\n \"address\" : {\n \"city\" : \"San Francisco\",\n \"country\" : \"US\",\n \"postalCode\" : \"94678\",\n \"stateOrProvince\" : \"CA\",\n \"line1\" : \"274\",\n \"line2\" : \"Brannan Street\"\n }\n },\n \"accountIdentification\" : {\n \"type\" : \"numberAndBic\",\n \"accountNumber\" : \"123456789\",\n \"bic\" : \"BOFAUS3NXXX\"\n }\n }\n },\n \"priority\" : \"crossBorder\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\",\n \"address\" : {\n \"city\" : \"San Francisco\",\n \"country\" : \"US\",\n \"postalCode\" : \"94678\",\n \"stateOrProvince\" : \"CA\",\n \"line1\" : \"274\",\n \"line2\" : \"Brannan Street\"\n }\n },\n \"accountIdentification\" : {\n \"type\" : \"numberAndBic\",\n \"accountNumber\" : \"123456789\",\n \"bic\" : \"BOFAUS3NXXX\"\n }\n }\n },\n \"paymentInstrumentId\" : \"PI3222G223222G59347DAA265\",\n \"paymentInstrument\" : {\n \"description\" : \"Your payment instrument description\",\n \"id\" : \"PI3222G223222G59347DAA265\",\n \"reference\" : \"Your payment instrument reference\"\n },\n \"priority\" : \"crossBorder\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\",\n \"address\" : {\n \"city\" : \"San Francisco\",\n \"country\" : \"US\",\n \"postalCode\" : \"94678\",\n \"stateOrProvince\" : \"CA\",\n \"line1\" : \"274\",\n \"line2\" : \"Brannan Street\"\n }\n },\n \"accountIdentification\" : {\n \"type\" : \"numberAndBic\",\n \"accountNumber\" : \"123456789\",\n \"bic\" : \"BOFAUS3NXXX\"\n }\n }\n },\n \"priority\" : \"crossBorder\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\",\n \"address\" : {\n \"city\" : \"San Francisco\",\n \"country\" : \"US\",\n \"postalCode\" : \"94678\",\n \"stateOrProvince\" : \"CA\",\n \"line1\" : \"274\",\n \"line2\" : \"Brannan Street\"\n }\n },\n \"accountIdentification\" : {\n \"type\" : \"numberAndBic\",\n \"accountNumber\" : \"123456789\",\n \"bic\" : \"BOFAUS3NXXX\"\n }\n }\n },\n \"priority\" : \"crossBorder\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Make a SEPA funds transfer", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n },\n \"paymentInstrumentId\" : \"PI3222G223222G59347DAA265\",\n \"paymentInstrument\" : {\n \"description\" : \"Your payment instrument description\",\n \"id\" : \"PI3222G223222G59347DAA265\",\n \"reference\" : \"Your payment instrument reference\"\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Make a US local funds transfer", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"USD\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"123456789\",\n \"routingNumber\" : \"011000138\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"USD\"\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"123456789\",\n \"routingNumber\" : \"011000138\"\n }\n }\n },\n \"paymentInstrumentId\" : \"PI3222G223222G59347DAA265\",\n \"paymentInstrument\" : {\n \"description\" : \"Your payment instrument description\",\n \"id\" : \"PI3222G223222G59347DAA265\",\n \"reference\" : \"Your payment instrument reference\"\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"USD\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"123456789\",\n \"routingNumber\" : \"011000138\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"USD\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"123456789\",\n \"routingNumber\" : \"011000138\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Transfer funds to another balance account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"internal\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32272223222B5LPRFDW7J9G\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"internal\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32272223222B5LPRFDW7J9G\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"internal\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32272223222B5LPRFDW7J9G\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"internal\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32272223222B5LPRFDW7J9G\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Pay out to a transfer instrument", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"paymentInstrumentId\" : \"PI3222G223222G59347DAA265\",\n \"paymentInstrument\" : {\n \"description\" : \"Your payment instrument description\",\n \"id\" : \"PI3222G223222G59347DAA265\",\n \"reference\" : \"Your payment instrument reference\"\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] } ] - } -, + }, { "name": "/transfers/:transferId/returns", "description": "Returns previously transferred funds without creating a new `transferId`.", @@ -418,56 +714,57 @@ { "name": "Return a transfer", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"reference\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers/:transferId/returns", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers", - ":transferId", - "returns" - ], - "variable": [ - { - "key": "transferId", - "value": "", - "description": "The unique identifier of the transfer to be returned." - } - ], - "query": [ - ] - }, - "description": "Returns previously transferred funds without creating a new `transferId`." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"reference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers/:transferId/returns", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers", + ":transferId", + "returns" + ], + "variable": [ + { + "key": "transferId", + "value": "", + "description": "The unique identifier of the transfer to be returned." + } + ], + "query": [ + ] + }, + "description": "Returns previously transferred funds without creating a new `transferId`." +} + ,"response": [ + ] } ] } - ] }, { @@ -480,49 +777,50 @@ { "name": "Get a capital account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grants" - ], - "variable": [ - ], - "query": [ - { - "key": "counterpartyAccountHolderId", - "value": "counterpartyAccountHolderId_example", - "description": "The counterparty account holder id.", - "disabled": true - } - ] - }, - "description": "Returns a list of grants with status and outstanding balances." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grants" + ], + "variable": [ + ], + "query": [ + { + "key": "counterpartyAccountHolderId", + "value": "counterpartyAccountHolderId_example", + "description": "The counterparty account holder id.", + "disabled": true + } + ] + }, + "description": "Returns a list of grants with status and outstanding balances." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/grants", "description": "Requests the payout of the selected grant offer.", @@ -530,49 +828,101 @@ { "name": "Request grant payout to a balance account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"grantAccountId\" : \"CG00000000000000000000001\",\n \"grantOfferId\" : \"0000000000000001\",\n \"counterparty\" : {\n \"accountHolderId\" : \"AH00000000000000000000001\",\n \"balanceAccountId\" : \"BA00000000000000000000001\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grants" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Requests the payout of the selected grant offer." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"GR00000000000000000000001\",\n \"grantAccountId\" : \"CG00000000000000000000001\",\n \"grantOfferId\" : \"0000000000000001\",\n \"counterparty\" : {\n \"accountHolderId\" : \"AH00000000000000000000001\",\n \"balanceAccountId\" : \"BA00000000000000000000001\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000000\n },\n \"fee\" : {\n \"amount\" : {\n \"value\" : 120000,\n \"currency\" : \"EUR\"\n }\n },\n \"balances\" : {\n \"currency\" : \"EUR\",\n \"fee\" : 120000,\n \"principal\" : 1000000,\n \"total\" : 1120000\n },\n \"repayment\" : {\n \"basisPoints\" : 1400\n },\n \"status\" : \"Pending\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"grantAccountId\" : \"CG00000000000000000000001\",\n \"grantOfferId\" : \"0000000000000001\",\n \"counterparty\" : {\n \"accountHolderId\" : \"AH00000000000000000000001\",\n \"balanceAccountId\" : \"BA00000000000000000000001\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grants" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Requests the payout of the selected grant offer." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"grantAccountId\" : \"CG00000000000000000000001\",\n \"grantOfferId\" : \"0000000000000001\",\n \"counterparty\" : {\n \"accountHolderId\" : \"AH00000000000000000000001\",\n \"balanceAccountId\" : \"BA00000000000000000000001\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grants" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Requests the payout of the selected grant offer." - } + ] } ] - } -, + }, { "name": "/grants/:id", "description": "Returns the details of a capital account specified in the path.", @@ -580,49 +930,50 @@ { "name": "Get grant reference details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grants/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grants", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the grant." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a capital account specified in the path." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grants/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grants", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the grant." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a capital account specified in the path." +} + ,"response": [ + ] } ] } - ] } ], diff --git a/postman/TransferService-v4.json b/postman/TransferService-v4.json index 26c2166..6c99570 100644 --- a/postman/TransferService-v4.json +++ b/postman/TransferService-v4.json @@ -19,91 +19,92 @@ { "name": "Get all transactions", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactions", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactions" - ], - "variable": [ - ], - "query": [ - { - "key": "balancePlatform", - "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", - "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", - "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", - "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", - "description": "The `cursor` returned in the links of the previous response.", - "disabled": true - }, - { - "key": "createdSince", - "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", - "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", - "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", - "disabled": true - } - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. " - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions" + ], + "variable": [ + ], + "query": [ + { + "key": "balancePlatform", + "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", + "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", + "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", + "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", + "description": "The `cursor` returned in the links of the previous response.", + "disabled": true + }, + { + "key": "createdSince", + "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", + "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", + "description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.", + "disabled": true + } + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. " +} + ,"response": [ + ] } ] - } -, + }, { "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.", @@ -111,49 +112,50 @@ { "name": "Get a transaction", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transactions/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transactions", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the transaction." - } - ], - "query": [ - ] - }, - "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." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transaction." + } + ], + "query": [ + ] + }, + "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." +} + ,"response": [ + ] } ] } - ] }, { @@ -166,251 +168,545 @@ { "name": "Make a cross-border transfer", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\",\n \"address\" : {\n \"city\" : \"San Francisco\",\n \"country\" : \"US\",\n \"postalCode\" : \"94678\",\n \"stateOrProvince\" : \"CA\",\n \"line1\" : \"274\",\n \"line2\" : \"Brannan Street\"\n }\n },\n \"accountIdentification\" : {\n \"type\" : \"numberAndBic\",\n \"accountNumber\" : \"123456789\",\n \"bic\" : \"BOFAUS3NXXX\"\n }\n }\n },\n \"priority\" : \"crossBorder\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"category\" : \"bank\",\n \"categoryData\" : {\n \"priority\" : \"crossBorder\",\n \"type\" : \"bank\"\n },\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\",\n \"address\" : {\n \"city\" : \"San Francisco\",\n \"country\" : \"US\",\n \"postalCode\" : \"94678\",\n \"stateOrProvince\" : \"CA\",\n \"line1\" : \"274\",\n \"line2\" : \"Brannan Street\"\n }\n },\n \"accountIdentification\" : {\n \"type\" : \"numberAndBic\",\n \"accountNumber\" : \"123456789\",\n \"bic\" : \"BOFAUS3NXXX\"\n }\n }\n },\n \"paymentInstrument\" : {\n \"description\" : \"Your payment instrument description\",\n \"id\" : \"PI3222G223222G59347DAA265\",\n \"reference\" : \"Your payment instrument reference\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\",\n \"address\" : {\n \"city\" : \"San Francisco\",\n \"country\" : \"US\",\n \"postalCode\" : \"94678\",\n \"stateOrProvince\" : \"CA\",\n \"line1\" : \"274\",\n \"line2\" : \"Brannan Street\"\n }\n },\n \"accountIdentification\" : {\n \"type\" : \"numberAndBic\",\n \"accountNumber\" : \"123456789\",\n \"bic\" : \"BOFAUS3NXXX\"\n }\n }\n },\n \"priority\" : \"crossBorder\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\",\n \"address\" : {\n \"city\" : \"San Francisco\",\n \"country\" : \"US\",\n \"postalCode\" : \"94678\",\n \"stateOrProvince\" : \"CA\",\n \"line1\" : \"274\",\n \"line2\" : \"Brannan Street\"\n }\n },\n \"accountIdentification\" : {\n \"type\" : \"numberAndBic\",\n \"accountNumber\" : \"123456789\",\n \"bic\" : \"BOFAUS3NXXX\"\n }\n }\n },\n \"priority\" : \"crossBorder\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Make a SEPA funds transfer", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"category\" : \"bank\",\n \"categoryData\" : {\n \"priority\" : \"regular\",\n \"type\" : \"bank\"\n },\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n },\n \"paymentInstrument\" : {\n \"description\" : \"Your payment instrument description\",\n \"id\" : \"PI3222G223222G59347DAA265\",\n \"reference\" : \"Your payment instrument reference\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"iban\",\n \"iban\" : \"NL91ABNA0417164300\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Make a US local funds transfer", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"USD\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"123456789\",\n \"routingNumber\" : \"011000138\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"USD\"\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"category\" : \"bank\",\n \"categoryData\" : {\n \"priority\" : \"regular\",\n \"type\" : \"bank\"\n },\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"123456789\",\n \"routingNumber\" : \"011000138\"\n }\n }\n },\n \"paymentInstrument\" : {\n \"description\" : \"Your payment instrument description\",\n \"id\" : \"PI3222G223222G59347DAA265\",\n \"reference\" : \"Your payment instrument reference\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"USD\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"123456789\",\n \"routingNumber\" : \"011000138\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 110000,\n \"currency\" : \"USD\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"bankAccount\" : {\n \"accountHolder\" : {\n \"fullName\" : \"A. Klaassen\"\n },\n \"accountIdentification\" : {\n \"type\" : \"usLocal\",\n \"accountNumber\" : \"123456789\",\n \"routingNumber\" : \"011000138\"\n }\n }\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Transfer funds to another balance account", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"internal\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32272223222B5LPRFDW7J9G\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 10000\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"category\" : \"internal\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32272223222B5LPRFDW7J9G\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"internal\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32272223222B5LPRFDW7J9G\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 10000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"internal\",\n \"counterparty\" : {\n \"balanceAccountId\" : \"BA32272223222B5LPRFDW7J9G\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] }, { "name": "Pay out to a transfer instrument", "request": { - "method": "POST", - "header": [ - { - "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 + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"1W1UG35U8A9J5ZLG\",\n \"accountHolder\" : {\n \"description\" : \"Your account holder description\",\n \"id\" : \"AH3227C223222C5GXQXF658WB\",\n \"reference\" : \"Your account holder reference\"\n },\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccount\" : {\n \"description\" : \"Your balance account description\",\n \"id\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\" : \"Your balance account reference\"\n },\n \"category\" : \"bank\",\n \"categoryData\" : {\n \"priority\" : \"regular\",\n \"type\" : \"bank\"\n },\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"paymentInstrument\" : {\n \"description\" : \"Your payment instrument description\",\n \"id\" : \"PI3222G223222G59347DAA265\",\n \"reference\" : \"Your payment instrument reference\"\n },\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\",\n \"direction\" : \"outgoing\",\n \"reason\" : \"approved\",\n \"status\" : \"authorised\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "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 + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\" : {\n \"value\" : 80000,\n \"currency\" : \"EUR\"\n },\n \"balanceAccountId\" : \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\" : \"bank\",\n \"counterparty\" : {\n \"transferInstrumentId\" : \"SE1234567890ABC1234567890\"\n },\n \"priority\" : \"regular\",\n \"referenceForBeneficiary\" : \"Your-reference-sent-to-the-beneficiary\",\n \"reference\" : \"Your internal reference for the transfer\",\n \"description\" : \"Your description for the transfer\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." - } + ] } ] - } -, + }, { "name": "/transfers/:transferId/returns", "description": "Returns previously transferred funds without creating a new `transferId`.", @@ -418,56 +714,57 @@ { "name": "Return a transfer", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"reference\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/transfers/:transferId/returns", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "transfers", - ":transferId", - "returns" - ], - "variable": [ - { - "key": "transferId", - "value": "", - "description": "The unique identifier of the transfer to be returned." - } - ], - "query": [ - ] - }, - "description": "Returns previously transferred funds without creating a new `transferId`." - } + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"reference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers/:transferId/returns", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers", + ":transferId", + "returns" + ], + "variable": [ + { + "key": "transferId", + "value": "", + "description": "The unique identifier of the transfer to be returned." + } + ], + "query": [ + ] + }, + "description": "Returns previously transferred funds without creating a new `transferId`." +} + ,"response": [ + ] } ] } - ] }, { @@ -480,49 +777,50 @@ { "name": "Get a capital account", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grants" - ], - "variable": [ - ], - "query": [ - { - "key": "counterpartyAccountHolderId", - "value": "counterpartyAccountHolderId_example", - "description": "The counterparty account holder id.", - "disabled": true - } - ] - }, - "description": "Returns a list of grants with status and outstanding balances." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grants" + ], + "variable": [ + ], + "query": [ + { + "key": "counterpartyAccountHolderId", + "value": "counterpartyAccountHolderId_example", + "description": "The counterparty account holder id.", + "disabled": true + } + ] + }, + "description": "Returns a list of grants with status and outstanding balances." +} + ,"response": [ + ] } ] - } -, + }, { "name": "/grants", "description": "Requests the payout of the selected grant offer.", @@ -530,49 +828,101 @@ { "name": "Request grant payout to a balance account", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "disabled": false - }, - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"grantAccountId\" : \"CG00000000000000000000001\",\n \"grantOfferId\" : \"0000000000000001\",\n \"counterparty\" : {\n \"accountHolderId\" : \"AH00000000000000000000001\",\n \"balanceAccountId\" : \"BA00000000000000000000001\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grants" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Requests the payout of the selected grant offer." +} + ,"response": [ + {"name": "OK - the request has succeeded.", + "code": 200, + "status": "OK", + "header": [{ + "key": "Content-Type", + "value": "application/json"} + ], + "_postman_previewlanguage": "json", + "cookie": [], + "body" : "{\n \"id\" : \"GR00000000000000000000001\",\n \"grantAccountId\" : \"CG00000000000000000000001\",\n \"grantOfferId\" : \"0000000000000001\",\n \"counterparty\" : {\n \"accountHolderId\" : \"AH00000000000000000000001\",\n \"balanceAccountId\" : \"BA00000000000000000000001\"\n },\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 1000000\n },\n \"fee\" : {\n \"amount\" : {\n \"value\" : 120000,\n \"currency\" : \"EUR\"\n }\n },\n \"balances\" : {\n \"currency\" : \"EUR\",\n \"fee\" : 120000,\n \"principal\" : 1000000,\n \"total\" : 1120000\n },\n \"repayment\" : {\n \"basisPoints\" : 1400\n },\n \"status\" : \"Pending\"\n}", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "disabled": false + }, + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"grantAccountId\" : \"CG00000000000000000000001\",\n \"grantOfferId\" : \"0000000000000001\",\n \"counterparty\" : {\n \"accountHolderId\" : \"AH00000000000000000000001\",\n \"balanceAccountId\" : \"BA00000000000000000000001\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grants" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Requests the payout of the selected grant offer." +} } - ], - "body": { - "mode": "raw", - "raw": "{\n \"grantAccountId\" : \"CG00000000000000000000001\",\n \"grantOfferId\" : \"0000000000000001\",\n \"counterparty\" : {\n \"accountHolderId\" : \"AH00000000000000000000001\",\n \"balanceAccountId\" : \"BA00000000000000000000001\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grants" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Requests the payout of the selected grant offer." - } + ] } ] - } -, + }, { "name": "/grants/:id", "description": "Returns the details of a capital account specified in the path.", @@ -580,49 +930,50 @@ { "name": "Get grant reference details", "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "", - "disabled": false - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grants/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grants", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the grant." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a capital account specified in the path." - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "description": "", + "disabled": false + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/grants/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "grants", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the grant." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a capital account specified in the path." +} + ,"response": [ + ] } ] } - ] } ],