jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2024-09-04 12:04:43 +02:00
parent 9c802537c9
commit 02e4f8c8c3
4 changed files with 1542 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

430
json/ManagementService-v1.json
View File

@@ -3955,6 +3955,12 @@
"content" : {
"application/json" : {
"examples" : {
"create-email-user" : {
"$ref" : "#/components/examples/post-companies-companyId-users-create-email-user"
},
"create-sso-user" : {
"$ref" : "#/components/examples/post-companies-companyId-users-create-sso-user"
},
"create-user" : {
"$ref" : "#/components/examples/post-companies-companyId-users-create-user"
}
@@ -4952,6 +4958,9 @@
"examples" : {
"post-company-webhook-test" : {
"$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test"
},
"post-company-webhook-test-custom" : {
"$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom"
}
},
"schema" : {
@@ -4987,6 +4996,9 @@
"examples" : {
"post-company-webhook-test" : {
"$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200"
},
"post-company-webhook-test-custom" : {
"$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom-200"
}
},
"schema" : {
@@ -12293,6 +12305,12 @@
"content" : {
"application/json" : {
"examples" : {
"create-email-user" : {
"$ref" : "#/components/examples/post-merchants-merchantId-users-create-email-user"
},
"create-sso-user" : {
"$ref" : "#/components/examples/post-merchants-merchantId-users-create-sso-user"
},
"create-user" : {
"$ref" : "#/components/examples/post-merchants-merchantId-users-create-user"
}
@@ -13313,6 +13331,9 @@
"examples" : {
"post-merchant-webhook-test" : {
"$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test"
},
"post-merchant-webhook-test-custom" : {
"$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom"
}
},
"schema" : {
@@ -13348,6 +13369,9 @@
"examples" : {
"post-merchant-webhook-test" : {
"$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200"
},
"post-merchant-webhook-test-custom" : {
"$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom-200"
}
},
"schema" : {
@@ -15033,6 +15057,28 @@
},
"components" : {
"schemas" : {
"AccelInfo" : {
"additionalProperties" : false,
"properties" : {
"processingType" : {
"description" : "The type of transactions processed over this payment method.\n Allowed values:\n- **pos** for in-person payments. \n- **billpay** for subscription payments, both the initial payment and the later recurring payments. These transactions have `recurringProcessingModel` **Subscription**. \n- **ecom** for all other card not present transactions. This includes non-recurring transactions and transactions with `recurringProcessingModel` **CardOnFile** or **UnscheduledCardOnFile**.\n",
"enum" : [
"billpay",
"ecom",
"pos"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"processingType"
],
"type" : "object"
},
"AdditionalCommission" : {
"additionalProperties" : false,
"properties" : {
@@ -15794,6 +15840,10 @@
"INVENTORY"
],
"type" : "string"
},
"terminalIPAddressURL" : {
"description" : "The list of local and public URLs to send notifications to when using local integrations.",
"$ref" : "#/components/schemas/EventUrl"
}
},
"type" : "object"
@@ -16631,14 +16681,14 @@
"additionalProperties" : false,
"properties" : {
"eventLocalUrls" : {
"description" : "One or more local URLs to send event notifications to when using Terminal API.",
"description" : "One or more local URLs to send event notifications to when using Terminal API or local integrations.",
"items" : {
"$ref" : "#/components/schemas/Url"
},
"type" : "array"
},
"eventPublicUrls" : {
"description" : "One or more public URLs to send event notifications to when using Terminal API.",
"description" : "One or more public URLs to send event notifications to when using Terminal API or local integrations.",
"items" : {
"$ref" : "#/components/schemas/Url"
},
@@ -17636,6 +17686,28 @@
},
"type" : "object"
},
"NyceInfo" : {
"additionalProperties" : false,
"properties" : {
"processingType" : {
"description" : "The type of transactions processed over this payment method.\n Allowed values:\n- **pos** for in-person payments. \n- **billpay** for subscription payments, both the initial payment and the later recurring payments. These transactions have `recurringProcessingModel` **Subscription**. \n- **ecom** for all other card not present transactions. This includes non-recurring transactions and transactions with `recurringProcessingModel` **CardOnFile** or **UnscheduledCardOnFile**.\n",
"enum" : [
"billpay",
"ecom",
"pos"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"processingType"
],
"type" : "object"
},
"OfflineProcessing" : {
"additionalProperties" : false,
"properties" : {
@@ -17781,6 +17853,29 @@
},
"type" : "object"
},
"PayMeInfo" : {
"additionalProperties" : false,
"properties" : {
"displayName" : {
"description" : "Merchant display name",
"type" : "string"
},
"logo" : {
"description" : "Merchant logo. Format: Base64-encoded string.",
"type" : "string"
},
"supportEmail" : {
"description" : "The email address of merchant support.",
"type" : "string"
}
},
"required" : [
"displayName",
"supportEmail",
"logo"
],
"type" : "object"
},
"PayPalInfo" : {
"additionalProperties" : false,
"properties" : {
@@ -17827,6 +17922,10 @@
"PaymentMethod" : {
"additionalProperties" : false,
"properties" : {
"accel" : {
"description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo"
},
"afterpayTouch" : {
"description" : "Afterpay Touch details.",
"$ref" : "#/components/schemas/AfterpayTouchInfo"
@@ -17933,7 +18032,7 @@
"$ref" : "#/components/schemas/KlarnaInfo"
},
"maestro" : {
"description" : "Maestro details.",
"description" : "Maestro details. In the US, `maestro` is not supported; use `maestro_usa` instead. ",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mc" : {
@@ -17944,10 +18043,22 @@
"description" : "Meal Voucher FR details.",
"$ref" : "#/components/schemas/MealVoucherFRInfo"
},
"nyce" : {
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"payme" : {
"description" : "PayMe details.",
"$ref" : "#/components/schemas/PayMeInfo"
},
"paypal" : {
"description" : "PayPal details.",
"$ref" : "#/components/schemas/PayPalInfo"
},
"pulse" : {
"description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo"
},
"reference" : {
"description" : "Your reference for the payment method. Supported characters a-z, A-Z, 0-9.",
"maxLength" : 150,
@@ -17957,16 +18068,24 @@
"description" : "The sales channel.",
"type" : "string"
},
"sodexo" : {
"description" : "Sodexo details.",
"$ref" : "#/components/schemas/SodexoInfo"
},
"sofort" : {
"description" : "Sofort details.",
"$ref" : "#/components/schemas/SofortInfo"
},
"star" : {
"description" : "STAR details.",
"$ref" : "#/components/schemas/StarInfo"
},
"storeId" : {
"description" : "The ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/stores__resParam_id), if any.",
"type" : "string"
},
"swish" : {
"description" : "Swish details.",
"description" : "Swish details.\n - This field is required only if you have a contract with Swish. Swish handles settlement directly with you (not through Adyen).\n - If not specified then it's assumed that you are using Adyen's contract with Swish.You don't have a direct relationship with Swish.\n",
"$ref" : "#/components/schemas/SwishInfo"
},
"ticket" : {
@@ -18041,16 +18160,25 @@
"description" : "Payment method types with errors.",
"items" : {
"enum" : [
"accel",
"afterpaytouch",
"alelo",
"alipay",
"alipay_hk",
"amex",
"applepay",
"banese_card",
"banese_card_credit",
"banese_card_debit",
"banese_card_prepaid",
"bcmc",
"blik",
"cartebancaire",
"clearpay",
"clicktopay",
"credtodos",
"credtodos_private_credit",
"credtodos_private_debit",
"cup",
"diners",
"directdebit_GB",
@@ -18077,17 +18205,27 @@
"mealVoucher_FR",
"mobilepay",
"multibanco",
"nyce",
"onlineBanking_PL",
"paybybank",
"payme",
"payme_pos",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"pulse",
"sodexo",
"star",
"swish",
"ticket",
"todo_giftcard",
"trustly",
"twint",
"twint_pos",
"up_brazil_credit",
"vale_refeicao",
"vale_refeicao_prepaid",
"vipps",
"visa",
"visadebit",
@@ -18109,6 +18247,10 @@
"PaymentMethodSetupInfo" : {
"additionalProperties" : false,
"properties" : {
"accel" : {
"description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo"
},
"afterpayTouch" : {
"description" : "Afterpay Touch details.",
"$ref" : "#/components/schemas/AfterpayTouchInfo"
@@ -18203,7 +18345,7 @@
"$ref" : "#/components/schemas/KlarnaInfo"
},
"maestro" : {
"description" : "Maestro details.",
"description" : "Maestro details. In the US, `maestro` is not supported; use `maestro_usa` instead. ",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mc" : {
@@ -18214,10 +18356,22 @@
"description" : "Meal Voucher FR details.",
"$ref" : "#/components/schemas/MealVoucherFRInfo"
},
"nyce" : {
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"payme" : {
"description" : "PayMe details.",
"$ref" : "#/components/schemas/PayMeInfo"
},
"paypal" : {
"description" : "PayPal details.",
"$ref" : "#/components/schemas/PayPalInfo"
},
"pulse" : {
"description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo"
},
"reference" : {
"description" : "Your reference for the payment method. Supported characters a-z, A-Z, 0-9.",
"maxLength" : 150,
@@ -18233,16 +18387,24 @@
],
"type" : "string"
},
"sodexo" : {
"description" : "Sodexo details.",
"$ref" : "#/components/schemas/SodexoInfo"
},
"sofort" : {
"description" : "Sofort details.",
"$ref" : "#/components/schemas/SofortInfo"
},
"star" : {
"description" : "STAR details.",
"$ref" : "#/components/schemas/StarInfo"
},
"storeId" : {
"description" : "The ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/stores__resParam_id), if any.",
"type" : "string"
},
"swish" : {
"description" : "Swish details.",
"description" : "Swish details.\n - This field is required only if you have a contract with Swish. Swish handles settlement directly with you (not through Adyen).\n - If not specified then it's assumed that you are using Adyen's contract with Swish.You don't have a direct relationship with Swish.\n",
"$ref" : "#/components/schemas/SwishInfo"
},
"ticket" : {
@@ -18256,16 +18418,25 @@
"type" : {
"description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
"enum" : [
"accel",
"afterpaytouch",
"alelo",
"alipay",
"alipay_hk",
"amex",
"applepay",
"banese_card",
"banese_card_credit",
"banese_card_debit",
"banese_card_prepaid",
"bcmc",
"blik",
"cartebancaire",
"clearpay",
"clicktopay",
"credtodos",
"credtodos_private_credit",
"credtodos_private_debit",
"cup",
"diners",
"directdebit_GB",
@@ -18292,17 +18463,27 @@
"mealVoucher_FR",
"mobilepay",
"multibanco",
"nyce",
"onlineBanking_PL",
"paybybank",
"payme",
"payme_pos",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"pulse",
"sodexo",
"star",
"swish",
"ticket",
"todo_giftcard",
"trustly",
"twint",
"twint_pos",
"up_brazil_credit",
"vale_refeicao",
"vale_refeicao_prepaid",
"vipps",
"visa",
"visadebit",
@@ -18509,6 +18690,28 @@
],
"type" : "object"
},
"PulseInfo" : {
"additionalProperties" : false,
"properties" : {
"processingType" : {
"description" : "The type of transactions processed over this payment method.\n Allowed values:\n- **pos** for in-person payments. \n- **billpay** for subscription payments, both the initial payment and the later recurring payments. These transactions have `recurringProcessingModel` **Subscription**. \n- **ecom** for all other card not present transactions. This includes non-recurring transactions and transactions with `recurringProcessingModel` **CardOnFile** or **UnscheduledCardOnFile**.\n",
"enum" : [
"billpay",
"ecom",
"pos"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"processingType"
],
"type" : "object"
},
"ReceiptOptions" : {
"additionalProperties" : false,
"properties" : {
@@ -18893,6 +19096,19 @@
},
"type" : "object"
},
"SodexoInfo" : {
"additionalProperties" : false,
"properties" : {
"merchantContactPhone" : {
"description" : "Sodexo merchantContactPhone",
"type" : "string"
}
},
"required" : [
"merchantContactPhone"
],
"type" : "object"
},
"SofortInfo" : {
"additionalProperties" : false,
"properties" : {
@@ -19160,6 +19376,28 @@
},
"type" : "object"
},
"StarInfo" : {
"additionalProperties" : false,
"properties" : {
"processingType" : {
"description" : "The type of transactions processed over this payment method.\n Allowed values:\n- **pos** for in-person payments. \n- **billpay** for subscription payments, both the initial payment and the later recurring payments. These transactions have `recurringProcessingModel` **Subscription**. \n- **ecom** for all other card not present transactions. This includes non-recurring transactions and transactions with `recurringProcessingModel` **CardOnFile** or **UnscheduledCardOnFile**.\n",
"enum" : [
"billpay",
"ecom",
"pos"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"processingType"
],
"type" : "object"
},
"Store" : {
"additionalProperties" : false,
"properties" : {
@@ -20408,6 +20646,10 @@
"UpdatePaymentMethodInfo" : {
"additionalProperties" : false,
"properties" : {
"accel" : {
"description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo"
},
"bcmc" : {
"description" : "Bancontact details.",
"$ref" : "#/components/schemas/BcmcInfo"
@@ -20474,13 +20716,25 @@
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"maestro" : {
"description" : "Maestro details.",
"description" : "Maestro details. In the US, `maestro` is not supported; use `maestro_usa` instead.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mc" : {
"description" : "MasterCard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"nyce" : {
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"pulse" : {
"description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo"
},
"star" : {
"description" : "STAR details.",
"$ref" : "#/components/schemas/StarInfo"
},
"storeIds" : {
"description" : "The list of stores for this payment method",
"items" : {
@@ -27694,6 +27948,48 @@
]
}
},
"post-companies-companyId-users-create-email-user" : {
"summary" : "Create a user with email as login method",
"description" : "Example request to create a user with email as login method on the company level",
"value" : {
"name" : {
"firstName" : "John",
"lastName" : "Smith"
},
"username" : "johnsmith",
"email" : "john.smith@example.com",
"loginMethod" : "Email",
"timeZoneCode" : "Europe/Amsterdam",
"roles" : [
"Merchant standard role",
"Merchant admin"
],
"associatedMerchantAccounts" : [
"YOUR_MERCHANT_ACCOUNT"
]
}
},
"post-companies-companyId-users-create-sso-user" : {
"summary" : "Create a user with SSO as login method",
"description" : "Example request to create a with SSO as login method user on the company level",
"value" : {
"name" : {
"firstName" : "John",
"lastName" : "Smith"
},
"username" : "johnsmith",
"email" : "john.smith@example.com",
"loginMethod" : "SSO",
"timeZoneCode" : "Europe/Amsterdam",
"roles" : [
"Merchant standard role",
"Merchant admin"
],
"associatedMerchantAccounts" : [
"YOUR_MERCHANT_ACCOUNT"
]
}
},
"post-companies-companyId-users-create-user" : {
"summary" : "Create a user",
"description" : "Example request to create a user on the company level",
@@ -27715,7 +28011,7 @@
}
},
"post-companies-companyId-users-create-user-200" : {
"summary" : "Response code - 200 OK",
"summary" : "User created on the company level",
"description" : "Example response after creating a user on the company level",
"value" : {
"id" : "S2-5C334C6770",
@@ -27874,8 +28170,36 @@
}
},
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test" : {
"summary" : "Test a webhook notification",
"description" : "Example request for testing a webhook notification.",
"summary" : "Test a webhook event",
"description" : "Example request for testing a webhook event.",
"value" : {
"merchantIds" : [
"YOUR_MERCHANT_ACCOUNT"
],
"types" : [
"AUTHORISATION"
]
}
},
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200" : {
"summary" : "OK 200 - Test a webhook event",
"description" : "Example response for testing a webhook event.",
"value" : {
"data" : [
{
"merchantId" : "YOUR_MERCHANT_ACCOUNT_AU",
"output" : "",
"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\"}}]}",
"responseCode" : "200",
"responseTime" : "657 ms",
"status" : "success"
}
]
}
},
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom" : {
"summary" : "Test a custom webhook event",
"description" : "Example request for testing a custom webhook event.",
"value" : {
"notification" : {
"paymentMethod" : "visa",
@@ -27889,12 +28213,17 @@
},
"types" : [
"CUSTOM"
],
"merchantIds" : [
"YOUR_MERCHANT_ACCOUNT_AU",
"YOUR_MERCHANT_ACCOUNT_EU",
"YOUR_MERCHANT_ACCOUNT_US"
]
}
},
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200" : {
"summary" : "OK 200 - Test a webhook notification",
"description" : "Example response for testing a webhook notification.",
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom-200" : {
"summary" : "OK 200 - Test a custom webhook event",
"description" : "Example response for testing a custom webhook event.",
"value" : {
"data" : [
{
@@ -28437,6 +28766,40 @@
]
}
},
"post-merchants-merchantId-users-create-email-user" : {
"summary" : "Create a user with email as login method",
"description" : "Example request to create a user with email as login method on the merchant level",
"value" : {
"name" : {
"firstName" : "John",
"lastName" : "Smith"
},
"username" : "johnsmith",
"email" : "john.smith@example.com",
"loginMethod" : "Email",
"timeZoneCode" : "Europe/Amsterdam",
"roles" : [
"Merchant standard role"
]
}
},
"post-merchants-merchantId-users-create-sso-user" : {
"summary" : "Create a user with SSO as login method",
"description" : "Example request to create a user with SSO as login method on the merchant level",
"value" : {
"name" : {
"firstName" : "John",
"lastName" : "Smith"
},
"username" : "johnsmith",
"email" : "john.smith@example.com",
"loginMethod" : "SSO",
"timeZoneCode" : "Europe/Amsterdam",
"roles" : [
"Merchant standard role"
]
}
},
"post-merchants-merchantId-users-create-user" : {
"summary" : "Create a user",
"description" : "Example request to create a user on the merchant level",
@@ -28454,7 +28817,7 @@
}
},
"post-merchants-merchantId-users-create-user-200" : {
"summary" : "Response code - 200 OK",
"summary" : "User created on the merchant level",
"description" : "Example response after creating a user on the merchant level",
"value" : {
"id" : "S2-3B3C3C3B22",
@@ -28601,14 +28964,39 @@
}
},
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test" : {
"summary" : "Test a webhook notification",
"description" : "Example request for testing a webhook notification.",
"summary" : "Test a custom webhook event",
"description" : "Example request for testing a custom webhook event.",
"value" : {
"types" : [
"AUTHORISATION"
]
}
},
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200" : {
"summary" : "OK 200 - Test a webhook event",
"description" : "Example response for testing a webhook event.",
"value" : {
"data" : [
{
"merchantId" : "YOUR_MERCHANT_ACCOUNT",
"output" : "",
"requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":21000},\"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\"}}]}",
"responseCode" : "200",
"responseTime" : "532 ms",
"status" : "success"
}
]
}
},
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom" : {
"summary" : "Test a custom webhook event",
"description" : "Example request for testing a custom webhook event.",
"value" : {
"notification" : {
"paymentMethod" : "visa",
"eventCode" : "AUTHORISATION",
"amount" : {
"currency" : "EUR",
"currency" : "HUF",
"value" : 1000
},
"reason" : "Authorize visa payment",
@@ -28619,15 +29007,15 @@
]
}
},
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200" : {
"summary" : "OK 200 - Test a webhook notification",
"description" : "Example response for testing a webhook notification.",
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom-200" : {
"summary" : "OK 200 - Test a webhook event",
"description" : "Example response for testing a webhook event.",
"value" : {
"data" : [
{
"merchantId" : "YOUR_MERCHANT_ACCOUNT",
"output" : "",
"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\"}}]}",
"requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"HUF\",\"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\"}}]}",
"responseCode" : "200",
"responseTime" : "532 ms",
"status" : "success"

430
json/ManagementService-v3.json
View File

@@ -4246,6 +4246,12 @@
"content" : {
"application/json" : {
"examples" : {
"create-email-user" : {
"$ref" : "#/components/examples/post-companies-companyId-users-create-email-user"
},
"create-sso-user" : {
"$ref" : "#/components/examples/post-companies-companyId-users-create-sso-user"
},
"create-user" : {
"$ref" : "#/components/examples/post-companies-companyId-users-create-user"
}
@@ -5243,6 +5249,9 @@
"examples" : {
"post-company-webhook-test" : {
"$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test"
},
"post-company-webhook-test-custom" : {
"$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom"
}
},
"schema" : {
@@ -5278,6 +5287,9 @@
"examples" : {
"post-company-webhook-test" : {
"$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200"
},
"post-company-webhook-test-custom" : {
"$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom-200"
}
},
"schema" : {
@@ -12584,6 +12596,12 @@
"content" : {
"application/json" : {
"examples" : {
"create-email-user" : {
"$ref" : "#/components/examples/post-merchants-merchantId-users-create-email-user"
},
"create-sso-user" : {
"$ref" : "#/components/examples/post-merchants-merchantId-users-create-sso-user"
},
"create-user" : {
"$ref" : "#/components/examples/post-merchants-merchantId-users-create-user"
}
@@ -13604,6 +13622,9 @@
"examples" : {
"post-merchant-webhook-test" : {
"$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test"
},
"post-merchant-webhook-test-custom" : {
"$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom"
}
},
"schema" : {
@@ -13639,6 +13660,9 @@
"examples" : {
"post-merchant-webhook-test" : {
"$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200"
},
"post-merchant-webhook-test-custom" : {
"$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom-200"
}
},
"schema" : {
@@ -15430,6 +15454,28 @@
},
"components" : {
"schemas" : {
"AccelInfo" : {
"additionalProperties" : false,
"properties" : {
"processingType" : {
"description" : "The type of transactions processed over this payment method.\n Allowed values:\n- **pos** for in-person payments. \n- **billpay** for subscription payments, both the initial payment and the later recurring payments. These transactions have `recurringProcessingModel` **Subscription**. \n- **ecom** for all other card not present transactions. This includes non-recurring transactions and transactions with `recurringProcessingModel` **CardOnFile** or **UnscheduledCardOnFile**.\n",
"enum" : [
"billpay",
"ecom",
"pos"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"processingType"
],
"type" : "object"
},
"AdditionalCommission" : {
"additionalProperties" : false,
"properties" : {
@@ -16219,6 +16265,10 @@
"INVENTORY"
],
"type" : "string"
},
"terminalIPAddressURL" : {
"description" : "The list of local and public URLs to send notifications to when using local integrations.",
"$ref" : "#/components/schemas/EventUrl"
}
},
"type" : "object"
@@ -17058,14 +17108,14 @@
"additionalProperties" : false,
"properties" : {
"eventLocalUrls" : {
"description" : "One or more local URLs to send event notifications to when using Terminal API.",
"description" : "One or more local URLs to send event notifications to when using Terminal API or local integrations.",
"items" : {
"$ref" : "#/components/schemas/Url"
},
"type" : "array"
},
"eventPublicUrls" : {
"description" : "One or more public URLs to send event notifications to when using Terminal API.",
"description" : "One or more public URLs to send event notifications to when using Terminal API or local integrations.",
"items" : {
"$ref" : "#/components/schemas/Url"
},
@@ -18056,6 +18106,28 @@
},
"type" : "object"
},
"NyceInfo" : {
"additionalProperties" : false,
"properties" : {
"processingType" : {
"description" : "The type of transactions processed over this payment method.\n Allowed values:\n- **pos** for in-person payments. \n- **billpay** for subscription payments, both the initial payment and the later recurring payments. These transactions have `recurringProcessingModel` **Subscription**. \n- **ecom** for all other card not present transactions. This includes non-recurring transactions and transactions with `recurringProcessingModel` **CardOnFile** or **UnscheduledCardOnFile**.\n",
"enum" : [
"billpay",
"ecom",
"pos"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"processingType"
],
"type" : "object"
},
"OfflineProcessing" : {
"additionalProperties" : false,
"properties" : {
@@ -18201,6 +18273,29 @@
},
"type" : "object"
},
"PayMeInfo" : {
"additionalProperties" : false,
"properties" : {
"displayName" : {
"description" : "Merchant display name",
"type" : "string"
},
"logo" : {
"description" : "Merchant logo. Format: Base64-encoded string.",
"type" : "string"
},
"supportEmail" : {
"description" : "The email address of merchant support.",
"type" : "string"
}
},
"required" : [
"displayName",
"supportEmail",
"logo"
],
"type" : "object"
},
"PayPalInfo" : {
"additionalProperties" : false,
"properties" : {
@@ -18247,6 +18342,10 @@
"PaymentMethod" : {
"additionalProperties" : false,
"properties" : {
"accel" : {
"description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo"
},
"afterpayTouch" : {
"description" : "Afterpay Touch details.",
"$ref" : "#/components/schemas/AfterpayTouchInfo"
@@ -18353,7 +18452,7 @@
"$ref" : "#/components/schemas/KlarnaInfo"
},
"maestro" : {
"description" : "Maestro details.",
"description" : "Maestro details. In the US, `maestro` is not supported; use `maestro_usa` instead. ",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mc" : {
@@ -18364,10 +18463,22 @@
"description" : "Meal Voucher FR details.",
"$ref" : "#/components/schemas/MealVoucherFRInfo"
},
"nyce" : {
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"payme" : {
"description" : "PayMe details.",
"$ref" : "#/components/schemas/PayMeInfo"
},
"paypal" : {
"description" : "PayPal details.",
"$ref" : "#/components/schemas/PayPalInfo"
},
"pulse" : {
"description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo"
},
"reference" : {
"description" : "Your reference for the payment method. Supported characters a-z, A-Z, 0-9.",
"maxLength" : 150,
@@ -18377,10 +18488,18 @@
"description" : "The sales channel.",
"type" : "string"
},
"sodexo" : {
"description" : "Sodexo details.",
"$ref" : "#/components/schemas/SodexoInfo"
},
"sofort" : {
"description" : "Sofort details.",
"$ref" : "#/components/schemas/SofortInfo"
},
"star" : {
"description" : "STAR details.",
"$ref" : "#/components/schemas/StarInfo"
},
"storeIds" : {
"x-addedInVersion" : "3",
"description" : "The unique identifier of the store for which to configure the payment method, if any.",
@@ -18390,7 +18509,7 @@
"type" : "array"
},
"swish" : {
"description" : "Swish details.",
"description" : "Swish details.\n - This field is required only if you have a contract with Swish. Swish handles settlement directly with you (not through Adyen).\n - If not specified then it's assumed that you are using Adyen's contract with Swish.You don't have a direct relationship with Swish.\n",
"$ref" : "#/components/schemas/SwishInfo"
},
"ticket" : {
@@ -18465,16 +18584,25 @@
"description" : "Payment method types with errors.",
"items" : {
"enum" : [
"accel",
"afterpaytouch",
"alelo",
"alipay",
"alipay_hk",
"amex",
"applepay",
"banese_card",
"banese_card_credit",
"banese_card_debit",
"banese_card_prepaid",
"bcmc",
"blik",
"cartebancaire",
"clearpay",
"clicktopay",
"credtodos",
"credtodos_private_credit",
"credtodos_private_debit",
"cup",
"diners",
"directdebit_GB",
@@ -18501,17 +18629,27 @@
"mealVoucher_FR",
"mobilepay",
"multibanco",
"nyce",
"onlineBanking_PL",
"paybybank",
"payme",
"payme_pos",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"pulse",
"sodexo",
"star",
"swish",
"ticket",
"todo_giftcard",
"trustly",
"twint",
"twint_pos",
"up_brazil_credit",
"vale_refeicao",
"vale_refeicao_prepaid",
"vipps",
"visa",
"visadebit",
@@ -18533,6 +18671,10 @@
"PaymentMethodSetupInfo" : {
"additionalProperties" : false,
"properties" : {
"accel" : {
"description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo"
},
"afterpayTouch" : {
"description" : "Afterpay Touch details.",
"$ref" : "#/components/schemas/AfterpayTouchInfo"
@@ -18627,7 +18769,7 @@
"$ref" : "#/components/schemas/KlarnaInfo"
},
"maestro" : {
"description" : "Maestro details.",
"description" : "Maestro details. In the US, `maestro` is not supported; use `maestro_usa` instead. ",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mc" : {
@@ -18638,10 +18780,22 @@
"description" : "Meal Voucher FR details.",
"$ref" : "#/components/schemas/MealVoucherFRInfo"
},
"nyce" : {
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"payme" : {
"description" : "PayMe details.",
"$ref" : "#/components/schemas/PayMeInfo"
},
"paypal" : {
"description" : "PayPal details.",
"$ref" : "#/components/schemas/PayPalInfo"
},
"pulse" : {
"description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo"
},
"reference" : {
"description" : "Your reference for the payment method. Supported characters a-z, A-Z, 0-9.",
"maxLength" : 150,
@@ -18657,10 +18811,18 @@
],
"type" : "string"
},
"sodexo" : {
"description" : "Sodexo details.",
"$ref" : "#/components/schemas/SodexoInfo"
},
"sofort" : {
"description" : "Sofort details.",
"$ref" : "#/components/schemas/SofortInfo"
},
"star" : {
"description" : "STAR details.",
"$ref" : "#/components/schemas/StarInfo"
},
"storeIds" : {
"x-addedInVersion" : "3",
"description" : "The unique identifier of the store for which to configure the payment method, if any.",
@@ -18670,7 +18832,7 @@
"type" : "array"
},
"swish" : {
"description" : "Swish details.",
"description" : "Swish details.\n - This field is required only if you have a contract with Swish. Swish handles settlement directly with you (not through Adyen).\n - If not specified then it's assumed that you are using Adyen's contract with Swish.You don't have a direct relationship with Swish.\n",
"$ref" : "#/components/schemas/SwishInfo"
},
"ticket" : {
@@ -18684,16 +18846,25 @@
"type" : {
"description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
"enum" : [
"accel",
"afterpaytouch",
"alelo",
"alipay",
"alipay_hk",
"amex",
"applepay",
"banese_card",
"banese_card_credit",
"banese_card_debit",
"banese_card_prepaid",
"bcmc",
"blik",
"cartebancaire",
"clearpay",
"clicktopay",
"credtodos",
"credtodos_private_credit",
"credtodos_private_debit",
"cup",
"diners",
"directdebit_GB",
@@ -18720,17 +18891,27 @@
"mealVoucher_FR",
"mobilepay",
"multibanco",
"nyce",
"onlineBanking_PL",
"paybybank",
"payme",
"payme_pos",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"pulse",
"sodexo",
"star",
"swish",
"ticket",
"todo_giftcard",
"trustly",
"twint",
"twint_pos",
"up_brazil_credit",
"vale_refeicao",
"vale_refeicao_prepaid",
"vipps",
"visa",
"visadebit",
@@ -18930,6 +19111,28 @@
],
"type" : "object"
},
"PulseInfo" : {
"additionalProperties" : false,
"properties" : {
"processingType" : {
"description" : "The type of transactions processed over this payment method.\n Allowed values:\n- **pos** for in-person payments. \n- **billpay** for subscription payments, both the initial payment and the later recurring payments. These transactions have `recurringProcessingModel` **Subscription**. \n- **ecom** for all other card not present transactions. This includes non-recurring transactions and transactions with `recurringProcessingModel` **CardOnFile** or **UnscheduledCardOnFile**.\n",
"enum" : [
"billpay",
"ecom",
"pos"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"processingType"
],
"type" : "object"
},
"ReceiptOptions" : {
"additionalProperties" : false,
"properties" : {
@@ -19314,6 +19517,19 @@
},
"type" : "object"
},
"SodexoInfo" : {
"additionalProperties" : false,
"properties" : {
"merchantContactPhone" : {
"description" : "Sodexo merchantContactPhone",
"type" : "string"
}
},
"required" : [
"merchantContactPhone"
],
"type" : "object"
},
"SofortInfo" : {
"additionalProperties" : false,
"properties" : {
@@ -19581,6 +19797,28 @@
},
"type" : "object"
},
"StarInfo" : {
"additionalProperties" : false,
"properties" : {
"processingType" : {
"description" : "The type of transactions processed over this payment method.\n Allowed values:\n- **pos** for in-person payments. \n- **billpay** for subscription payments, both the initial payment and the later recurring payments. These transactions have `recurringProcessingModel` **Subscription**. \n- **ecom** for all other card not present transactions. This includes non-recurring transactions and transactions with `recurringProcessingModel` **CardOnFile** or **UnscheduledCardOnFile**.\n",
"enum" : [
"billpay",
"ecom",
"pos"
],
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\n> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
"processingType"
],
"type" : "object"
},
"Store" : {
"additionalProperties" : false,
"properties" : {
@@ -20941,6 +21179,10 @@
"UpdatePaymentMethodInfo" : {
"additionalProperties" : false,
"properties" : {
"accel" : {
"description" : "ACCEL details.",
"$ref" : "#/components/schemas/AccelInfo"
},
"bcmc" : {
"description" : "Bancontact details.",
"$ref" : "#/components/schemas/BcmcInfo"
@@ -21007,13 +21249,25 @@
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"maestro" : {
"description" : "Maestro details.",
"description" : "Maestro details. In the US, `maestro` is not supported; use `maestro_usa` instead.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mc" : {
"description" : "MasterCard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"nyce" : {
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"pulse" : {
"description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo"
},
"star" : {
"description" : "STAR details.",
"$ref" : "#/components/schemas/StarInfo"
},
"storeIds" : {
"description" : "The list of stores for this payment method",
"items" : {
@@ -28246,6 +28500,48 @@
]
}
},
"post-companies-companyId-users-create-email-user" : {
"summary" : "Create a user with email as login method",
"description" : "Example request to create a user with email as login method on the company level",
"value" : {
"name" : {
"firstName" : "John",
"lastName" : "Smith"
},
"username" : "johnsmith",
"email" : "john.smith@example.com",
"loginMethod" : "Email",
"timeZoneCode" : "Europe/Amsterdam",
"roles" : [
"Merchant standard role",
"Merchant admin"
],
"associatedMerchantAccounts" : [
"YOUR_MERCHANT_ACCOUNT"
]
}
},
"post-companies-companyId-users-create-sso-user" : {
"summary" : "Create a user with SSO as login method",
"description" : "Example request to create a with SSO as login method user on the company level",
"value" : {
"name" : {
"firstName" : "John",
"lastName" : "Smith"
},
"username" : "johnsmith",
"email" : "john.smith@example.com",
"loginMethod" : "SSO",
"timeZoneCode" : "Europe/Amsterdam",
"roles" : [
"Merchant standard role",
"Merchant admin"
],
"associatedMerchantAccounts" : [
"YOUR_MERCHANT_ACCOUNT"
]
}
},
"post-companies-companyId-users-create-user" : {
"summary" : "Create a user",
"description" : "Example request to create a user on the company level",
@@ -28267,7 +28563,7 @@
}
},
"post-companies-companyId-users-create-user-200" : {
"summary" : "Response code - 200 OK",
"summary" : "User created on the company level",
"description" : "Example response after creating a user on the company level",
"value" : {
"id" : "S2-5C334C6770",
@@ -28424,8 +28720,36 @@
}
},
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test" : {
"summary" : "Test a webhook notification",
"description" : "Example request for testing a webhook notification.",
"summary" : "Test a webhook event",
"description" : "Example request for testing a webhook event.",
"value" : {
"merchantIds" : [
"YOUR_MERCHANT_ACCOUNT"
],
"types" : [
"AUTHORISATION"
]
}
},
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200" : {
"summary" : "OK 200 - Test a webhook event",
"description" : "Example response for testing a webhook event.",
"value" : {
"data" : [
{
"merchantId" : "YOUR_MERCHANT_ACCOUNT_AU",
"output" : "",
"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\"}}]}",
"responseCode" : "200",
"responseTime" : "657 ms",
"status" : "success"
}
]
}
},
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom" : {
"summary" : "Test a custom webhook event",
"description" : "Example request for testing a custom webhook event.",
"value" : {
"notification" : {
"paymentMethod" : "visa",
@@ -28439,12 +28763,17 @@
},
"types" : [
"CUSTOM"
],
"merchantIds" : [
"YOUR_MERCHANT_ACCOUNT_AU",
"YOUR_MERCHANT_ACCOUNT_EU",
"YOUR_MERCHANT_ACCOUNT_US"
]
}
},
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200" : {
"summary" : "OK 200 - Test a webhook notification",
"description" : "Example response for testing a webhook notification.",
"post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom-200" : {
"summary" : "OK 200 - Test a custom webhook event",
"description" : "Example response for testing a custom webhook event.",
"value" : {
"data" : [
{
@@ -28985,6 +29314,40 @@
]
}
},
"post-merchants-merchantId-users-create-email-user" : {
"summary" : "Create a user with email as login method",
"description" : "Example request to create a user with email as login method on the merchant level",
"value" : {
"name" : {
"firstName" : "John",
"lastName" : "Smith"
},
"username" : "johnsmith",
"email" : "john.smith@example.com",
"loginMethod" : "Email",
"timeZoneCode" : "Europe/Amsterdam",
"roles" : [
"Merchant standard role"
]
}
},
"post-merchants-merchantId-users-create-sso-user" : {
"summary" : "Create a user with SSO as login method",
"description" : "Example request to create a user with SSO as login method on the merchant level",
"value" : {
"name" : {
"firstName" : "John",
"lastName" : "Smith"
},
"username" : "johnsmith",
"email" : "john.smith@example.com",
"loginMethod" : "SSO",
"timeZoneCode" : "Europe/Amsterdam",
"roles" : [
"Merchant standard role"
]
}
},
"post-merchants-merchantId-users-create-user" : {
"summary" : "Create a user",
"description" : "Example request to create a user on the merchant level",
@@ -29002,7 +29365,7 @@
}
},
"post-merchants-merchantId-users-create-user-200" : {
"summary" : "Response code - 200 OK",
"summary" : "User created on the merchant level",
"description" : "Example response after creating a user on the merchant level",
"value" : {
"id" : "S2-3B3C3C3B22",
@@ -29147,14 +29510,39 @@
}
},
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test" : {
"summary" : "Test a webhook notification",
"description" : "Example request for testing a webhook notification.",
"summary" : "Test a custom webhook event",
"description" : "Example request for testing a custom webhook event.",
"value" : {
"types" : [
"AUTHORISATION"
]
}
},
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200" : {
"summary" : "OK 200 - Test a webhook event",
"description" : "Example response for testing a webhook event.",
"value" : {
"data" : [
{
"merchantId" : "YOUR_MERCHANT_ACCOUNT",
"output" : "",
"requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":21000},\"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\"}}]}",
"responseCode" : "200",
"responseTime" : "532 ms",
"status" : "success"
}
]
}
},
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom" : {
"summary" : "Test a custom webhook event",
"description" : "Example request for testing a custom webhook event.",
"value" : {
"notification" : {
"paymentMethod" : "visa",
"eventCode" : "AUTHORISATION",
"amount" : {
"currency" : "EUR",
"currency" : "HUF",
"value" : 1000
},
"reason" : "Authorize visa payment",
@@ -29165,15 +29553,15 @@
]
}
},
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200" : {
"summary" : "OK 200 - Test a webhook notification",
"description" : "Example response for testing a webhook notification.",
"post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom-200" : {
"summary" : "OK 200 - Test a webhook event",
"description" : "Example response for testing a webhook event.",
"value" : {
"data" : [
{
"merchantId" : "YOUR_MERCHANT_ACCOUNT",
"output" : "",
"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\"}}]}",
"requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"HUF\",\"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\"}}]}",
"responseCode" : "200",
"responseTime" : "532 ms",
"status" : "success"

383
yaml/ManagementService-v1.yaml
View File

@@ -2604,6 +2604,10 @@ paths:
content:
application/json:
examples:
create-email-user:
$ref: '#/components/examples/post-companies-companyId-users-create-email-user'
create-sso-user:
$ref: '#/components/examples/post-companies-companyId-users-create-sso-user'
create-user:
$ref: '#/components/examples/post-companies-companyId-users-create-user'
schema:
@@ -3244,6 +3248,8 @@ paths:
examples:
post-company-webhook-test:
$ref: '#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test'
post-company-webhook-test-custom:
$ref: '#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom'
schema:
$ref: '#/components/schemas/TestCompanyWebhookRequest'
parameters:
@@ -3266,6 +3272,8 @@ paths:
examples:
post-company-webhook-test:
$ref: '#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200'
post-company-webhook-test-custom:
$ref: '#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom-200'
schema:
$ref: '#/components/schemas/TestWebhookResponse'
description: OK - the request has succeeded.
@@ -8039,6 +8047,10 @@ paths:
content:
application/json:
examples:
create-email-user:
$ref: '#/components/examples/post-merchants-merchantId-users-create-email-user'
create-sso-user:
$ref: '#/components/examples/post-merchants-merchantId-users-create-sso-user'
create-user:
$ref: '#/components/examples/post-merchants-merchantId-users-create-user'
schema:
@@ -8701,6 +8713,8 @@ paths:
examples:
post-merchant-webhook-test:
$ref: '#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test'
post-merchant-webhook-test-custom:
$ref: '#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom'
schema:
$ref: '#/components/schemas/TestWebhookRequest'
parameters:
@@ -8723,6 +8737,8 @@ paths:
examples:
post-merchant-webhook-test:
$ref: '#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200'
post-merchant-webhook-test-custom:
$ref: '#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom-200'
schema:
$ref: '#/components/schemas/TestWebhookResponse'
description: OK - the request has succeeded.
@@ -9825,6 +9841,30 @@ paths:
description: Internal Server Error - the server could not process the request.
components:
schemas:
AccelInfo:
additionalProperties: false
properties:
processingType:
description: "The type of transactions processed over this payment method.\n\
\ Allowed values:\n- **pos** for in-person payments. \n- **billpay** for\
\ subscription payments, both the initial payment and the later recurring\
\ payments. These transactions have `recurringProcessingModel` **Subscription**.\
\ \n- **ecom** for all other card not present transactions. This includes\
\ non-recurring transactions and transactions with `recurringProcessingModel`\
\ **CardOnFile** or **UnscheduledCardOnFile**.\n"
enum:
- billpay
- ecom
- pos
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- processingType
type: object
AdditionalCommission:
additionalProperties: false
properties:
@@ -10498,6 +10538,10 @@ components:
- ACTIVATED
- INVENTORY
type: string
terminalIPAddressURL:
description: The list of local and public URLs to send notifications to
when using local integrations.
$ref: '#/components/schemas/EventUrl'
type: object
Contact:
additionalProperties: false
@@ -11388,13 +11432,13 @@ components:
properties:
eventLocalUrls:
description: One or more local URLs to send event notifications to when
using Terminal API.
using Terminal API or local integrations.
items:
$ref: '#/components/schemas/Url'
type: array
eventPublicUrls:
description: One or more public URLs to send event notifications to when
using Terminal API.
using Terminal API or local integrations.
items:
$ref: '#/components/schemas/Url'
type: array
@@ -12225,6 +12269,30 @@ components:
$ref: '#/components/schemas/Url'
type: array
type: object
NyceInfo:
additionalProperties: false
properties:
processingType:
description: "The type of transactions processed over this payment method.\n\
\ Allowed values:\n- **pos** for in-person payments. \n- **billpay** for\
\ subscription payments, both the initial payment and the later recurring\
\ payments. These transactions have `recurringProcessingModel` **Subscription**.\
\ \n- **ecom** for all other card not present transactions. This includes\
\ non-recurring transactions and transactions with `recurringProcessingModel`\
\ **CardOnFile** or **UnscheduledCardOnFile**.\n"
enum:
- billpay
- ecom
- pos
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- processingType
type: object
OfflineProcessing:
additionalProperties: false
properties:
@@ -12338,6 +12406,23 @@ components:
nullable: true
type: string
type: object
PayMeInfo:
additionalProperties: false
properties:
displayName:
description: Merchant display name
type: string
logo:
description: 'Merchant logo. Format: Base64-encoded string.'
type: string
supportEmail:
description: The email address of merchant support.
type: string
required:
- displayName
- supportEmail
- logo
type: object
PayPalInfo:
additionalProperties: false
properties:
@@ -12378,6 +12463,9 @@ components:
PaymentMethod:
additionalProperties: false
properties:
accel:
description: ACCEL details.
$ref: '#/components/schemas/AccelInfo'
afterpayTouch:
description: Afterpay Touch details.
$ref: '#/components/schemas/AfterpayTouchInfo'
@@ -12463,7 +12551,8 @@ components:
description: Klarna details.
$ref: '#/components/schemas/KlarnaInfo'
maestro:
description: Maestro details.
description: 'Maestro details. In the US, `maestro` is not supported; use
`maestro_usa` instead. '
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mc:
description: MasterCard details.
@@ -12471,9 +12560,18 @@ components:
mealVoucher_FR:
description: Meal Voucher FR details.
$ref: '#/components/schemas/MealVoucherFRInfo'
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
payme:
description: PayMe details.
$ref: '#/components/schemas/PayMeInfo'
paypal:
description: PayPal details.
$ref: '#/components/schemas/PayPalInfo'
pulse:
description: PULSE details.
$ref: '#/components/schemas/PulseInfo'
reference:
description: Your reference for the payment method. Supported characters
a-z, A-Z, 0-9.
@@ -12482,15 +12580,25 @@ components:
shopperInteraction:
description: The sales channel.
type: string
sodexo:
description: Sodexo details.
$ref: '#/components/schemas/SodexoInfo'
sofort:
description: Sofort details.
$ref: '#/components/schemas/SofortInfo'
star:
description: STAR details.
$ref: '#/components/schemas/StarInfo'
storeId:
description: The ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/stores__resParam_id),
if any.
type: string
swish:
description: Swish details.
description: "Swish details.\n - This field is required only if you have\
\ a contract with Swish. Swish handles settlement directly with you (not\
\ through Adyen).\n - If not specified then it's assumed that you are\
\ using Adyen's contract with Swish.You don't have a direct relationship\
\ with Swish.\n"
$ref: '#/components/schemas/SwishInfo'
ticket:
description: Edenred details.
@@ -12555,16 +12663,25 @@ components:
description: Payment method types with errors.
items:
enum:
- accel
- afterpaytouch
- alelo
- alipay
- alipay_hk
- amex
- applepay
- banese_card
- banese_card_credit
- banese_card_debit
- banese_card_prepaid
- bcmc
- blik
- cartebancaire
- clearpay
- clicktopay
- credtodos
- credtodos_private_credit
- credtodos_private_debit
- cup
- diners
- directdebit_GB
@@ -12591,17 +12708,27 @@ components:
- mealVoucher_FR
- mobilepay
- multibanco
- nyce
- onlineBanking_PL
- paybybank
- payme
- payme_pos
- paynow
- paynow_pos
- paypal
- payshop
- pulse
- sodexo
- star
- swish
- ticket
- todo_giftcard
- trustly
- twint
- twint_pos
- up_brazil_credit
- vale_refeicao
- vale_refeicao_prepaid
- vipps
- visa
- visadebit
@@ -12617,6 +12744,9 @@ components:
PaymentMethodSetupInfo:
additionalProperties: false
properties:
accel:
description: ACCEL details.
$ref: '#/components/schemas/AccelInfo'
afterpayTouch:
description: Afterpay Touch details.
$ref: '#/components/schemas/AfterpayTouchInfo'
@@ -12691,7 +12821,8 @@ components:
description: Klarna details.
$ref: '#/components/schemas/KlarnaInfo'
maestro:
description: Maestro details.
description: 'Maestro details. In the US, `maestro` is not supported; use
`maestro_usa` instead. '
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mc:
description: MasterCard details.
@@ -12699,9 +12830,18 @@ components:
mealVoucher_FR:
description: Meal Voucher FR details.
$ref: '#/components/schemas/MealVoucherFRInfo'
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
payme:
description: PayMe details.
$ref: '#/components/schemas/PayMeInfo'
paypal:
description: PayPal details.
$ref: '#/components/schemas/PayPalInfo'
pulse:
description: PULSE details.
$ref: '#/components/schemas/PulseInfo'
reference:
description: Your reference for the payment method. Supported characters
a-z, A-Z, 0-9.
@@ -12720,15 +12860,25 @@ components:
- moto
- contAuth
type: string
sodexo:
description: Sodexo details.
$ref: '#/components/schemas/SodexoInfo'
sofort:
description: Sofort details.
$ref: '#/components/schemas/SofortInfo'
star:
description: STAR details.
$ref: '#/components/schemas/StarInfo'
storeId:
description: The ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/stores__resParam_id),
if any.
type: string
swish:
description: Swish details.
description: "Swish details.\n - This field is required only if you have\
\ a contract with Swish. Swish handles settlement directly with you (not\
\ through Adyen).\n - If not specified then it's assumed that you are\
\ using Adyen's contract with Swish.You don't have a direct relationship\
\ with Swish.\n"
$ref: '#/components/schemas/SwishInfo'
ticket:
description: Edenred details.
@@ -12739,16 +12889,25 @@ components:
type:
description: Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).
enum:
- accel
- afterpaytouch
- alelo
- alipay
- alipay_hk
- amex
- applepay
- banese_card
- banese_card_credit
- banese_card_debit
- banese_card_prepaid
- bcmc
- blik
- cartebancaire
- clearpay
- clicktopay
- credtodos
- credtodos_private_credit
- credtodos_private_debit
- cup
- diners
- directdebit_GB
@@ -12775,17 +12934,27 @@ components:
- mealVoucher_FR
- mobilepay
- multibanco
- nyce
- onlineBanking_PL
- paybybank
- payme
- payme_pos
- paynow
- paynow_pos
- paypal
- payshop
- pulse
- sodexo
- star
- swish
- ticket
- todo_giftcard
- trustly
- twint
- twint_pos
- up_brazil_credit
- vale_refeicao
- vale_refeicao_prepaid
- vipps
- visa
- visadebit
@@ -13027,6 +13196,30 @@ components:
- authType
- wsec
type: object
PulseInfo:
additionalProperties: false
properties:
processingType:
description: "The type of transactions processed over this payment method.\n\
\ Allowed values:\n- **pos** for in-person payments. \n- **billpay** for\
\ subscription payments, both the initial payment and the later recurring\
\ payments. These transactions have `recurringProcessingModel` **Subscription**.\
\ \n- **ecom** for all other card not present transactions. This includes\
\ non-recurring transactions and transactions with `recurringProcessingModel`\
\ **CardOnFile** or **UnscheduledCardOnFile**.\n"
enum:
- billpay
- ecom
- pos
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- processingType
type: object
ReceiptOptions:
additionalProperties: false
properties:
@@ -13337,6 +13530,15 @@ components:
and UnionPay) regard a signature as optional.
type: boolean
type: object
SodexoInfo:
additionalProperties: false
properties:
merchantContactPhone:
description: Sodexo merchantContactPhone
type: string
required:
- merchantContactPhone
type: object
SofortInfo:
additionalProperties: false
properties:
@@ -13662,6 +13864,30 @@ components:
description: Enable standalone mode.
type: boolean
type: object
StarInfo:
additionalProperties: false
properties:
processingType:
description: "The type of transactions processed over this payment method.\n\
\ Allowed values:\n- **pos** for in-person payments. \n- **billpay** for\
\ subscription payments, both the initial payment and the later recurring\
\ payments. These transactions have `recurringProcessingModel` **Subscription**.\
\ \n- **ecom** for all other card not present transactions. This includes\
\ non-recurring transactions and transactions with `recurringProcessingModel`\
\ **CardOnFile** or **UnscheduledCardOnFile**.\n"
enum:
- billpay
- ecom
- pos
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- processingType
type: object
Store:
additionalProperties: false
properties:
@@ -14866,6 +15092,9 @@ components:
UpdatePaymentMethodInfo:
additionalProperties: false
properties:
accel:
description: ACCEL details.
$ref: '#/components/schemas/AccelInfo'
bcmc:
description: Bancontact details.
$ref: '#/components/schemas/BcmcInfo'
@@ -14918,11 +15147,21 @@ components:
description: JCB details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
maestro:
description: Maestro details.
description: Maestro details. In the US, `maestro` is not supported; use
`maestro_usa` instead.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mc:
description: MasterCard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
pulse:
description: PULSE details.
$ref: '#/components/schemas/PulseInfo'
star:
description: STAR details.
$ref: '#/components/schemas/StarInfo'
storeIds:
description: The list of stores for this payment method
items:
@@ -20410,6 +20649,40 @@ components:
- id: PART-175746-EU
name: Adyen Test Card
quantity: 1
post-companies-companyId-users-create-email-user:
summary: Create a user with email as login method
description: Example request to create a user with email as login method on
the company level
value:
name:
firstName: John
lastName: Smith
username: johnsmith
email: john.smith@example.com
loginMethod: Email
timeZoneCode: Europe/Amsterdam
roles:
- Merchant standard role
- Merchant admin
associatedMerchantAccounts:
- YOUR_MERCHANT_ACCOUNT
post-companies-companyId-users-create-sso-user:
summary: Create a user with SSO as login method
description: Example request to create a with SSO as login method user on the
company level
value:
name:
firstName: John
lastName: Smith
username: johnsmith
email: john.smith@example.com
loginMethod: SSO
timeZoneCode: Europe/Amsterdam
roles:
- Merchant standard role
- Merchant admin
associatedMerchantAccounts:
- YOUR_MERCHANT_ACCOUNT
post-companies-companyId-users-create-user:
summary: Create a user
description: Example request to create a user on the company level
@@ -20426,7 +20699,7 @@ components:
associatedMerchantAccounts:
- YOUR_MERCHANT_ACCOUNT
post-companies-companyId-users-create-user-200:
summary: Response code - 200 OK
summary: User created on the company level
description: Example response after creating a user on the company level
value:
id: S2-5C334C6770
@@ -20563,8 +20836,27 @@ components:
value:
hmacKey: 7052E6804F0AF40DCC390464C817F4F963516FA42AC8816D518DC5D39F41E902
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test:
summary: Test a webhook notification
description: Example request for testing a webhook notification.
summary: Test a webhook event
description: Example request for testing a webhook event.
value:
merchantIds:
- YOUR_MERCHANT_ACCOUNT
types:
- AUTHORISATION
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200:
summary: OK 200 - Test a webhook event
description: Example response for testing a webhook event.
value:
data:
- merchantId: YOUR_MERCHANT_ACCOUNT_AU
output: ''
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"}}]}'
responseCode: '200'
responseTime: 657 ms
status: success
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom:
summary: Test a custom webhook event
description: Example request for testing a custom webhook event.
value:
notification:
paymentMethod: visa
@@ -20576,9 +20868,13 @@ components:
success: true
types:
- CUSTOM
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200:
summary: OK 200 - Test a webhook notification
description: Example response for testing a webhook notification.
merchantIds:
- YOUR_MERCHANT_ACCOUNT_AU
- YOUR_MERCHANT_ACCOUNT_EU
- YOUR_MERCHANT_ACCOUNT_US
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom-200:
summary: OK 200 - Test a custom webhook event
description: Example response for testing a custom webhook event.
value:
data:
- merchantId: YOUR_MERCHANT_ACCOUNT_AU
@@ -20983,6 +21279,34 @@ components:
- id: PART-620222-EU
name: Receipt Roll
quantity: 20
post-merchants-merchantId-users-create-email-user:
summary: Create a user with email as login method
description: Example request to create a user with email as login method on
the merchant level
value:
name:
firstName: John
lastName: Smith
username: johnsmith
email: john.smith@example.com
loginMethod: Email
timeZoneCode: Europe/Amsterdam
roles:
- Merchant standard role
post-merchants-merchantId-users-create-sso-user:
summary: Create a user with SSO as login method
description: Example request to create a user with SSO as login method on the
merchant level
value:
name:
firstName: John
lastName: Smith
username: johnsmith
email: john.smith@example.com
loginMethod: SSO
timeZoneCode: Europe/Amsterdam
roles:
- Merchant standard role
post-merchants-merchantId-users-create-user:
summary: Create a user
description: Example request to create a user on the merchant level
@@ -20996,7 +21320,7 @@ components:
roles:
- Merchant standard role
post-merchants-merchantId-users-create-user-200:
summary: Response code - 200 OK
summary: User created on the merchant level
description: Example response after creating a user on the merchant level
value:
id: S2-3B3C3C3B22
@@ -21124,27 +21448,44 @@ components:
value:
hmacKey: 7052E6804F0AF40DCC390464C817F4F963516FA42AC8816D518DC5D39F41E902
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test:
summary: Test a webhook notification
description: Example request for testing a webhook notification.
summary: Test a custom webhook event
description: Example request for testing a custom webhook event.
value:
types:
- AUTHORISATION
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200:
summary: OK 200 - Test a webhook event
description: Example response for testing a webhook event.
value:
data:
- merchantId: YOUR_MERCHANT_ACCOUNT
output: ''
requestSent: '{"live":"false","notificationItems":[{"NotificationRequestItem":{"amount":{"currency":"EUR","value":21000},"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"}}]}'
responseCode: '200'
responseTime: 532 ms
status: success
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom:
summary: Test a custom webhook event
description: Example request for testing a custom webhook event.
value:
notification:
paymentMethod: visa
eventCode: AUTHORISATION
amount:
currency: EUR
currency: HUF
value: 1000
reason: Authorize visa payment
success: true
types:
- CUSTOM
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200:
summary: OK 200 - Test a webhook notification
description: Example response for testing a webhook notification.
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom-200:
summary: OK 200 - Test a webhook event
description: Example response for testing a webhook event.
value:
data:
- merchantId: YOUR_MERCHANT_ACCOUNT
output: ''
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"}}]}'
requestSent: '{"live":"false","notificationItems":[{"NotificationRequestItem":{"amount":{"currency":"HUF","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"}}]}'
responseCode: '200'
responseTime: 532 ms
status: success

383
yaml/ManagementService-v3.yaml
View File

@@ -2791,6 +2791,10 @@ paths:
content:
application/json:
examples:
create-email-user:
$ref: '#/components/examples/post-companies-companyId-users-create-email-user'
create-sso-user:
$ref: '#/components/examples/post-companies-companyId-users-create-sso-user'
create-user:
$ref: '#/components/examples/post-companies-companyId-users-create-user'
schema:
@@ -3431,6 +3435,8 @@ paths:
examples:
post-company-webhook-test:
$ref: '#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test'
post-company-webhook-test-custom:
$ref: '#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom'
schema:
$ref: '#/components/schemas/TestCompanyWebhookRequest'
parameters:
@@ -3453,6 +3459,8 @@ paths:
examples:
post-company-webhook-test:
$ref: '#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200'
post-company-webhook-test-custom:
$ref: '#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom-200'
schema:
$ref: '#/components/schemas/TestWebhookResponse'
description: OK - the request has succeeded.
@@ -8226,6 +8234,10 @@ paths:
content:
application/json:
examples:
create-email-user:
$ref: '#/components/examples/post-merchants-merchantId-users-create-email-user'
create-sso-user:
$ref: '#/components/examples/post-merchants-merchantId-users-create-sso-user'
create-user:
$ref: '#/components/examples/post-merchants-merchantId-users-create-user'
schema:
@@ -8888,6 +8900,8 @@ paths:
examples:
post-merchant-webhook-test:
$ref: '#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test'
post-merchant-webhook-test-custom:
$ref: '#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom'
schema:
$ref: '#/components/schemas/TestWebhookRequest'
parameters:
@@ -8910,6 +8924,8 @@ paths:
examples:
post-merchant-webhook-test:
$ref: '#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200'
post-merchant-webhook-test-custom:
$ref: '#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom-200'
schema:
$ref: '#/components/schemas/TestWebhookResponse'
description: OK - the request has succeeded.
@@ -10079,6 +10095,30 @@ paths:
description: Internal Server Error - the server could not process the request.
components:
schemas:
AccelInfo:
additionalProperties: false
properties:
processingType:
description: "The type of transactions processed over this payment method.\n\
\ Allowed values:\n- **pos** for in-person payments. \n- **billpay** for\
\ subscription payments, both the initial payment and the later recurring\
\ payments. These transactions have `recurringProcessingModel` **Subscription**.\
\ \n- **ecom** for all other card not present transactions. This includes\
\ non-recurring transactions and transactions with `recurringProcessingModel`\
\ **CardOnFile** or **UnscheduledCardOnFile**.\n"
enum:
- billpay
- ecom
- pos
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- processingType
type: object
AdditionalCommission:
additionalProperties: false
properties:
@@ -10775,6 +10815,10 @@ components:
- ACTIVATED
- INVENTORY
type: string
terminalIPAddressURL:
description: The list of local and public URLs to send notifications to
when using local integrations.
$ref: '#/components/schemas/EventUrl'
type: object
Contact:
additionalProperties: false
@@ -11667,13 +11711,13 @@ components:
properties:
eventLocalUrls:
description: One or more local URLs to send event notifications to when
using Terminal API.
using Terminal API or local integrations.
items:
$ref: '#/components/schemas/Url'
type: array
eventPublicUrls:
description: One or more public URLs to send event notifications to when
using Terminal API.
using Terminal API or local integrations.
items:
$ref: '#/components/schemas/Url'
type: array
@@ -12500,6 +12544,30 @@ components:
$ref: '#/components/schemas/Url'
type: array
type: object
NyceInfo:
additionalProperties: false
properties:
processingType:
description: "The type of transactions processed over this payment method.\n\
\ Allowed values:\n- **pos** for in-person payments. \n- **billpay** for\
\ subscription payments, both the initial payment and the later recurring\
\ payments. These transactions have `recurringProcessingModel` **Subscription**.\
\ \n- **ecom** for all other card not present transactions. This includes\
\ non-recurring transactions and transactions with `recurringProcessingModel`\
\ **CardOnFile** or **UnscheduledCardOnFile**.\n"
enum:
- billpay
- ecom
- pos
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- processingType
type: object
OfflineProcessing:
additionalProperties: false
properties:
@@ -12613,6 +12681,23 @@ components:
nullable: true
type: string
type: object
PayMeInfo:
additionalProperties: false
properties:
displayName:
description: Merchant display name
type: string
logo:
description: 'Merchant logo. Format: Base64-encoded string.'
type: string
supportEmail:
description: The email address of merchant support.
type: string
required:
- displayName
- supportEmail
- logo
type: object
PayPalInfo:
additionalProperties: false
properties:
@@ -12653,6 +12738,9 @@ components:
PaymentMethod:
additionalProperties: false
properties:
accel:
description: ACCEL details.
$ref: '#/components/schemas/AccelInfo'
afterpayTouch:
description: Afterpay Touch details.
$ref: '#/components/schemas/AfterpayTouchInfo'
@@ -12738,7 +12826,8 @@ components:
description: Klarna details.
$ref: '#/components/schemas/KlarnaInfo'
maestro:
description: Maestro details.
description: 'Maestro details. In the US, `maestro` is not supported; use
`maestro_usa` instead. '
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mc:
description: MasterCard details.
@@ -12746,9 +12835,18 @@ components:
mealVoucher_FR:
description: Meal Voucher FR details.
$ref: '#/components/schemas/MealVoucherFRInfo'
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
payme:
description: PayMe details.
$ref: '#/components/schemas/PayMeInfo'
paypal:
description: PayPal details.
$ref: '#/components/schemas/PayPalInfo'
pulse:
description: PULSE details.
$ref: '#/components/schemas/PulseInfo'
reference:
description: Your reference for the payment method. Supported characters
a-z, A-Z, 0-9.
@@ -12757,9 +12855,15 @@ components:
shopperInteraction:
description: The sales channel.
type: string
sodexo:
description: Sodexo details.
$ref: '#/components/schemas/SodexoInfo'
sofort:
description: Sofort details.
$ref: '#/components/schemas/SofortInfo'
star:
description: STAR details.
$ref: '#/components/schemas/StarInfo'
storeIds:
x-addedInVersion: '3'
description: The unique identifier of the store for which to configure the
@@ -12768,7 +12872,11 @@ components:
type: string
type: array
swish:
description: Swish details.
description: "Swish details.\n - This field is required only if you have\
\ a contract with Swish. Swish handles settlement directly with you (not\
\ through Adyen).\n - If not specified then it's assumed that you are\
\ using Adyen's contract with Swish.You don't have a direct relationship\
\ with Swish.\n"
$ref: '#/components/schemas/SwishInfo'
ticket:
description: Edenred details.
@@ -12833,16 +12941,25 @@ components:
description: Payment method types with errors.
items:
enum:
- accel
- afterpaytouch
- alelo
- alipay
- alipay_hk
- amex
- applepay
- banese_card
- banese_card_credit
- banese_card_debit
- banese_card_prepaid
- bcmc
- blik
- cartebancaire
- clearpay
- clicktopay
- credtodos
- credtodos_private_credit
- credtodos_private_debit
- cup
- diners
- directdebit_GB
@@ -12869,17 +12986,27 @@ components:
- mealVoucher_FR
- mobilepay
- multibanco
- nyce
- onlineBanking_PL
- paybybank
- payme
- payme_pos
- paynow
- paynow_pos
- paypal
- payshop
- pulse
- sodexo
- star
- swish
- ticket
- todo_giftcard
- trustly
- twint
- twint_pos
- up_brazil_credit
- vale_refeicao
- vale_refeicao_prepaid
- vipps
- visa
- visadebit
@@ -12895,6 +13022,9 @@ components:
PaymentMethodSetupInfo:
additionalProperties: false
properties:
accel:
description: ACCEL details.
$ref: '#/components/schemas/AccelInfo'
afterpayTouch:
description: Afterpay Touch details.
$ref: '#/components/schemas/AfterpayTouchInfo'
@@ -12969,7 +13099,8 @@ components:
description: Klarna details.
$ref: '#/components/schemas/KlarnaInfo'
maestro:
description: Maestro details.
description: 'Maestro details. In the US, `maestro` is not supported; use
`maestro_usa` instead. '
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mc:
description: MasterCard details.
@@ -12977,9 +13108,18 @@ components:
mealVoucher_FR:
description: Meal Voucher FR details.
$ref: '#/components/schemas/MealVoucherFRInfo'
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
payme:
description: PayMe details.
$ref: '#/components/schemas/PayMeInfo'
paypal:
description: PayPal details.
$ref: '#/components/schemas/PayPalInfo'
pulse:
description: PULSE details.
$ref: '#/components/schemas/PulseInfo'
reference:
description: Your reference for the payment method. Supported characters
a-z, A-Z, 0-9.
@@ -12998,9 +13138,15 @@ components:
- moto
- contAuth
type: string
sodexo:
description: Sodexo details.
$ref: '#/components/schemas/SodexoInfo'
sofort:
description: Sofort details.
$ref: '#/components/schemas/SofortInfo'
star:
description: STAR details.
$ref: '#/components/schemas/StarInfo'
storeIds:
x-addedInVersion: '3'
description: The unique identifier of the store for which to configure the
@@ -13009,7 +13155,11 @@ components:
type: string
type: array
swish:
description: Swish details.
description: "Swish details.\n - This field is required only if you have\
\ a contract with Swish. Swish handles settlement directly with you (not\
\ through Adyen).\n - If not specified then it's assumed that you are\
\ using Adyen's contract with Swish.You don't have a direct relationship\
\ with Swish.\n"
$ref: '#/components/schemas/SwishInfo'
ticket:
description: Edenred details.
@@ -13020,16 +13170,25 @@ components:
type:
description: Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).
enum:
- accel
- afterpaytouch
- alelo
- alipay
- alipay_hk
- amex
- applepay
- banese_card
- banese_card_credit
- banese_card_debit
- banese_card_prepaid
- bcmc
- blik
- cartebancaire
- clearpay
- clicktopay
- credtodos
- credtodos_private_credit
- credtodos_private_debit
- cup
- diners
- directdebit_GB
@@ -13056,17 +13215,27 @@ components:
- mealVoucher_FR
- mobilepay
- multibanco
- nyce
- onlineBanking_PL
- paybybank
- payme
- payme_pos
- paynow
- paynow_pos
- paypal
- payshop
- pulse
- sodexo
- star
- swish
- ticket
- todo_giftcard
- trustly
- twint
- twint_pos
- up_brazil_credit
- vale_refeicao
- vale_refeicao_prepaid
- vipps
- visa
- visadebit
@@ -13304,6 +13473,30 @@ components:
- authType
- wsec
type: object
PulseInfo:
additionalProperties: false
properties:
processingType:
description: "The type of transactions processed over this payment method.\n\
\ Allowed values:\n- **pos** for in-person payments. \n- **billpay** for\
\ subscription payments, both the initial payment and the later recurring\
\ payments. These transactions have `recurringProcessingModel` **Subscription**.\
\ \n- **ecom** for all other card not present transactions. This includes\
\ non-recurring transactions and transactions with `recurringProcessingModel`\
\ **CardOnFile** or **UnscheduledCardOnFile**.\n"
enum:
- billpay
- ecom
- pos
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- processingType
type: object
ReceiptOptions:
additionalProperties: false
properties:
@@ -13612,6 +13805,15 @@ components:
and UnionPay) regard a signature as optional.
type: boolean
type: object
SodexoInfo:
additionalProperties: false
properties:
merchantContactPhone:
description: Sodexo merchantContactPhone
type: string
required:
- merchantContactPhone
type: object
SofortInfo:
additionalProperties: false
properties:
@@ -13937,6 +14139,30 @@ components:
description: Enable standalone mode.
type: boolean
type: object
StarInfo:
additionalProperties: false
properties:
processingType:
description: "The type of transactions processed over this payment method.\n\
\ Allowed values:\n- **pos** for in-person payments. \n- **billpay** for\
\ subscription payments, both the initial payment and the later recurring\
\ payments. These transactions have `recurringProcessingModel` **Subscription**.\
\ \n- **ecom** for all other card not present transactions. This includes\
\ non-recurring transactions and transactions with `recurringProcessingModel`\
\ **CardOnFile** or **UnscheduledCardOnFile**.\n"
enum:
- billpay
- ecom
- pos
type: string
transactionDescription:
description: 'Information regarding the transaction description.
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- processingType
type: object
Store:
additionalProperties: false
properties:
@@ -15295,6 +15521,9 @@ components:
UpdatePaymentMethodInfo:
additionalProperties: false
properties:
accel:
description: ACCEL details.
$ref: '#/components/schemas/AccelInfo'
bcmc:
description: Bancontact details.
$ref: '#/components/schemas/BcmcInfo'
@@ -15347,11 +15576,21 @@ components:
description: JCB details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
maestro:
description: Maestro details.
description: Maestro details. In the US, `maestro` is not supported; use
`maestro_usa` instead.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mc:
description: MasterCard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
pulse:
description: PULSE details.
$ref: '#/components/schemas/PulseInfo'
star:
description: STAR details.
$ref: '#/components/schemas/StarInfo'
storeIds:
description: The list of stores for this payment method
items:
@@ -20861,6 +21100,40 @@ components:
- id: PART-175746-EU
name: Adyen Test Card
quantity: 1
post-companies-companyId-users-create-email-user:
summary: Create a user with email as login method
description: Example request to create a user with email as login method on
the company level
value:
name:
firstName: John
lastName: Smith
username: johnsmith
email: john.smith@example.com
loginMethod: Email
timeZoneCode: Europe/Amsterdam
roles:
- Merchant standard role
- Merchant admin
associatedMerchantAccounts:
- YOUR_MERCHANT_ACCOUNT
post-companies-companyId-users-create-sso-user:
summary: Create a user with SSO as login method
description: Example request to create a with SSO as login method user on the
company level
value:
name:
firstName: John
lastName: Smith
username: johnsmith
email: john.smith@example.com
loginMethod: SSO
timeZoneCode: Europe/Amsterdam
roles:
- Merchant standard role
- Merchant admin
associatedMerchantAccounts:
- YOUR_MERCHANT_ACCOUNT
post-companies-companyId-users-create-user:
summary: Create a user
description: Example request to create a user on the company level
@@ -20877,7 +21150,7 @@ components:
associatedMerchantAccounts:
- YOUR_MERCHANT_ACCOUNT
post-companies-companyId-users-create-user-200:
summary: Response code - 200 OK
summary: User created on the company level
description: Example response after creating a user on the company level
value:
id: S2-5C334C6770
@@ -21012,8 +21285,27 @@ components:
value:
hmacKey: 7052E6804F0AF40DCC390464C817F4F963516FA42AC8816D518DC5D39F41E902
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test:
summary: Test a webhook notification
description: Example request for testing a webhook notification.
summary: Test a webhook event
description: Example request for testing a webhook event.
value:
merchantIds:
- YOUR_MERCHANT_ACCOUNT
types:
- AUTHORISATION
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200:
summary: OK 200 - Test a webhook event
description: Example response for testing a webhook event.
value:
data:
- merchantId: YOUR_MERCHANT_ACCOUNT_AU
output: ''
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"}}]}'
responseCode: '200'
responseTime: 657 ms
status: success
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom:
summary: Test a custom webhook event
description: Example request for testing a custom webhook event.
value:
notification:
paymentMethod: visa
@@ -21025,9 +21317,13 @@ components:
success: true
types:
- CUSTOM
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200:
summary: OK 200 - Test a webhook notification
description: Example response for testing a webhook notification.
merchantIds:
- YOUR_MERCHANT_ACCOUNT_AU
- YOUR_MERCHANT_ACCOUNT_EU
- YOUR_MERCHANT_ACCOUNT_US
post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-custom-200:
summary: OK 200 - Test a custom webhook event
description: Example response for testing a custom webhook event.
value:
data:
- merchantId: YOUR_MERCHANT_ACCOUNT_AU
@@ -21430,6 +21726,34 @@ components:
- id: PART-620222-EU
name: Receipt Roll
quantity: 20
post-merchants-merchantId-users-create-email-user:
summary: Create a user with email as login method
description: Example request to create a user with email as login method on
the merchant level
value:
name:
firstName: John
lastName: Smith
username: johnsmith
email: john.smith@example.com
loginMethod: Email
timeZoneCode: Europe/Amsterdam
roles:
- Merchant standard role
post-merchants-merchantId-users-create-sso-user:
summary: Create a user with SSO as login method
description: Example request to create a user with SSO as login method on the
merchant level
value:
name:
firstName: John
lastName: Smith
username: johnsmith
email: john.smith@example.com
loginMethod: SSO
timeZoneCode: Europe/Amsterdam
roles:
- Merchant standard role
post-merchants-merchantId-users-create-user:
summary: Create a user
description: Example request to create a user on the merchant level
@@ -21443,7 +21767,7 @@ components:
roles:
- Merchant standard role
post-merchants-merchantId-users-create-user-200:
summary: Response code - 200 OK
summary: User created on the merchant level
description: Example response after creating a user on the merchant level
value:
id: S2-3B3C3C3B22
@@ -21569,27 +21893,44 @@ components:
value:
hmacKey: 7052E6804F0AF40DCC390464C817F4F963516FA42AC8816D518DC5D39F41E902
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test:
summary: Test a webhook notification
description: Example request for testing a webhook notification.
summary: Test a custom webhook event
description: Example request for testing a custom webhook event.
value:
types:
- AUTHORISATION
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200:
summary: OK 200 - Test a webhook event
description: Example response for testing a webhook event.
value:
data:
- merchantId: YOUR_MERCHANT_ACCOUNT
output: ''
requestSent: '{"live":"false","notificationItems":[{"NotificationRequestItem":{"amount":{"currency":"EUR","value":21000},"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"}}]}'
responseCode: '200'
responseTime: 532 ms
status: success
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom:
summary: Test a custom webhook event
description: Example request for testing a custom webhook event.
value:
notification:
paymentMethod: visa
eventCode: AUTHORISATION
amount:
currency: EUR
currency: HUF
value: 1000
reason: Authorize visa payment
success: true
types:
- CUSTOM
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200:
summary: OK 200 - Test a webhook notification
description: Example response for testing a webhook notification.
post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-custom-200:
summary: OK 200 - Test a webhook event
description: Example response for testing a webhook event.
value:
data:
- merchantId: YOUR_MERCHANT_ACCOUNT
output: ''
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"}}]}'
requestSent: '{"live":"false","notificationItems":[{"NotificationRequestItem":{"amount":{"currency":"HUF","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"}}]}'
responseCode: '200'
responseTime: 532 ms
status: success