spec release

This commit is contained in:
Adyen Automation
2025-05-14 17:32:54 +02:00
parent 3fadf4c1e8
commit 7d49d645b4
4 changed files with 316 additions and 104 deletions

View File

@@ -15206,6 +15206,10 @@
"AfterpayTouchInfo" : {
"additionalProperties" : false,
"properties" : {
"supportEmail" : {
"description" : "Support Email",
"type" : "string"
},
"supportUrl" : {
"description" : "Support Url",
"type" : "string"
@@ -16317,7 +16321,7 @@
"type" : "string"
},
"type" : {
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **direct-debit-notice-of-change**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {
@@ -16554,7 +16558,7 @@
"type" : "string"
},
"type" : {
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **direct-debit-notice-of-change**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {
@@ -16875,19 +16879,6 @@
},
"type" : "object"
},
"GiroPayInfo" : {
"additionalProperties" : false,
"properties" : {
"supportEmail" : {
"description" : "The email address of merchant support.",
"type" : "string"
}
},
"required" : [
"supportEmail"
],
"type" : "object"
},
"GooglePayInfo" : {
"additionalProperties" : false,
"properties" : {
@@ -17037,7 +17028,7 @@
"additionalProperties" : false,
"properties" : {
"midNumber" : {
"description" : "MID (Merchant ID) number. Required for merchants operating in Japan.Format: 14 numeric characters.",
"description" : "MID (Merchant ID) number. Required for merchants operating in Japan or merchants operating in Canada, Australia and New Zealand when requesting `gatewayContract` or `paymentDesignatorContract` service levels.Format: 14 numeric characters for Japan, 10 numeric characters for Canada, Australia and New Zealand.",
"maxLength" : 14,
"type" : "string"
},
@@ -17047,10 +17038,11 @@
"type" : "boolean"
},
"serviceLevel" : {
"description" : "Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan.\nPossible values:\n* **noContract**: Adyen holds the contract with JCB.\n* **gatewayContract**: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.",
"description" : "Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan.\nPossible values:\n* **noContract**: Adyen holds the contract with JCB for merchants operating in Japan or American Express for merchants operating in Canada, Australia and New Zealand.\n* **gatewayContract**: JCB or American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.\n* **paymentDesignatorContract**: Available only for merchants operating in Canada, Australia and New Zealand. Adyen receives the settlement, and handles disputes and payouts.",
"enum" : [
"noContract",
"gatewayContract"
"gatewayContract",
"paymentDesignatorContract"
],
"type" : "string"
},
@@ -17945,6 +17937,48 @@
},
"type" : "object"
},
"PayByBankPlaidInfo" : {
"additionalProperties" : false,
"properties" : {
"countryCode" : {
"description" : "Country Code.",
"type" : "string"
},
"logo" : {
"description" : "Merchant logo (max. size 150kB). Format: Base64-encoded string.",
"type" : "string"
},
"merchantCity" : {
"description" : "The city the merchant is doing business in.",
"type" : "string"
},
"merchantLegalName" : {
"description" : "Legal Business Name of the Merchant.",
"type" : "string"
},
"merchantShopUrl" : {
"description" : "Merchant shop url.",
"type" : "string"
},
"merchantStateProvince" : {
"description" : "The state/province of the merchant.",
"type" : "string"
},
"merchantStreetAddress" : {
"description" : "The street address of the merchant.",
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\nx> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
},
"zipCode" : {
"description" : "The zip code of the account.",
"type" : "string"
}
},
"type" : "object"
},
"PayMeInfo" : {
"additionalProperties" : false,
"properties" : {
@@ -18117,10 +18151,6 @@
"description" : "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
"type" : "boolean"
},
"giroPay" : {
"description" : "giropay details.",
"$ref" : "#/components/schemas/GiroPayInfo"
},
"girocard" : {
"description" : "Girocard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -18165,6 +18195,10 @@
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"paybybank_plaid" : {
"description" : "PayByBank Plaid details.",
"$ref" : "#/components/schemas/PayByBankPlaidInfo"
},
"payme" : {
"description" : "PayMe details.",
"$ref" : "#/components/schemas/PayMeInfo"
@@ -18334,12 +18368,12 @@
"nyce",
"onlineBanking_PL",
"paybybank",
"paybybank_plaid",
"payme",
"payme_pos",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"payto",
"pulse",
"sodexo",
@@ -18451,10 +18485,6 @@
"description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"giroPay" : {
"description" : "giropay details.",
"$ref" : "#/components/schemas/GiroPayInfo"
},
"girocard" : {
"description" : "Girocard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -18495,6 +18525,10 @@
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"paybybank_plaid" : {
"description" : "PayByBank Plaid details.",
"$ref" : "#/components/schemas/PayByBankPlaidInfo"
},
"payme" : {
"description" : "PayMe details.",
"$ref" : "#/components/schemas/PayMeInfo"
@@ -18609,12 +18643,12 @@
"nyce",
"onlineBanking_PL",
"paybybank",
"paybybank_plaid",
"payme",
"payme_pos",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"payto",
"pulse",
"sodexo",
@@ -18773,6 +18807,10 @@
"description" : "Indicates whether this is your preferred wireless network. If **true**, the terminal will try connecting to this network first.",
"type" : "boolean"
},
"domainSuffix" : {
"description" : "Specifies the server domain name for EAP-TLS and EAP-PEAP WiFi profiles on Android 11 and above.",
"type" : "string"
},
"eap" : {
"description" : "For `authType` **wpa-eap** or **wpa2-eap**. Possible values: **tls**, **peap**, **leap**, **fast**",
"type" : "string"
@@ -19457,8 +19495,11 @@
"fundingSource" : {
"description" : "The funding source of the payment method. This only applies to card transactions.\n\nPossible values:\n* **credit**\n* **debit**\n* **prepaid**\n* **deferred_debit**\n* **charged**\n* **ANY**",
"enum" : [
"charged",
"credit",
"debit",
"deferred_debit",
"prepaid",
"ANY"
],
"type" : "string"
@@ -19505,6 +19546,10 @@
"minLength" : 3,
"type" : "string"
},
"enableGratuities" : {
"description" : "Indicates whether the tipping options specified in `gratuities` are enabled on the standalone terminal.",
"type" : "boolean"
},
"enableStandalone" : {
"description" : "Enable standalone mode.",
"type" : "boolean"
@@ -20284,7 +20329,7 @@
"type" : "string"
},
"output" : {
"description" : "The response your server returned for the test webhook.\n\nYour server must respond with **HTTP 2xx* for the test webhook to be successful (`data.status`: **success**). Find out more about [accepting notifications](https://docs.adyen.com/development-resources/webhooks#accept-notifications)\n\nYou can use the value of this field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot unsuccessful test webhooks.",
"description" : "A short, human-readable explanation of the test result.\n\nYour server must respond with **HTTP 2xx* for the test webhook to be successful (`data.status`: **success**). Find out more about [accepting notifications](https://docs.adyen.com/development-resources/webhooks#accept-notifications)\n\nYou can use the value of this field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot unsuccessful test webhooks.",
"type" : "string"
},
"requestSent" : {
@@ -20871,6 +20916,10 @@
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"paybybank_plaid" : {
"description" : "PayByBank Plaid details.",
"$ref" : "#/components/schemas/PayByBankPlaidInfo"
},
"pulse" : {
"description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo"
@@ -21364,7 +21413,7 @@
"type" : "string"
},
"type" : {
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **direct-debit-notice-of-change**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {

View File

@@ -15603,6 +15603,10 @@
"AfterpayTouchInfo" : {
"additionalProperties" : false,
"properties" : {
"supportEmail" : {
"description" : "Support Email",
"type" : "string"
},
"supportUrl" : {
"description" : "Support Url",
"type" : "string"
@@ -16743,7 +16747,7 @@
"type" : "boolean"
},
"type" : {
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **direct-debit-notice-of-change**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {
@@ -16981,7 +16985,7 @@
"type" : "boolean"
},
"type" : {
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **direct-debit-notice-of-change**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {
@@ -17302,19 +17306,6 @@
},
"type" : "object"
},
"GiroPayInfo" : {
"additionalProperties" : false,
"properties" : {
"supportEmail" : {
"description" : "The email address of merchant support.",
"type" : "string"
}
},
"required" : [
"supportEmail"
],
"type" : "object"
},
"GooglePayInfo" : {
"additionalProperties" : false,
"properties" : {
@@ -17457,7 +17448,7 @@
"additionalProperties" : false,
"properties" : {
"midNumber" : {
"description" : "MID (Merchant ID) number. Required for merchants operating in Japan.Format: 14 numeric characters.",
"description" : "MID (Merchant ID) number. Required for merchants operating in Japan or merchants operating in Canada, Australia and New Zealand when requesting `gatewayContract` or `paymentDesignatorContract` service levels.Format: 14 numeric characters for Japan, 10 numeric characters for Canada, Australia and New Zealand.",
"maxLength" : 14,
"type" : "string"
},
@@ -17467,10 +17458,11 @@
"type" : "boolean"
},
"serviceLevel" : {
"description" : "Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan.\nPossible values:\n* **noContract**: Adyen holds the contract with JCB.\n* **gatewayContract**: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.",
"description" : "Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan.\nPossible values:\n* **noContract**: Adyen holds the contract with JCB for merchants operating in Japan or American Express for merchants operating in Canada, Australia and New Zealand.\n* **gatewayContract**: JCB or American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.\n* **paymentDesignatorContract**: Available only for merchants operating in Canada, Australia and New Zealand. Adyen receives the settlement, and handles disputes and payouts.",
"enum" : [
"noContract",
"gatewayContract"
"gatewayContract",
"paymentDesignatorContract"
],
"type" : "string"
},
@@ -18365,6 +18357,48 @@
},
"type" : "object"
},
"PayByBankPlaidInfo" : {
"additionalProperties" : false,
"properties" : {
"countryCode" : {
"description" : "Country Code.",
"type" : "string"
},
"logo" : {
"description" : "Merchant logo (max. size 150kB). Format: Base64-encoded string.",
"type" : "string"
},
"merchantCity" : {
"description" : "The city the merchant is doing business in.",
"type" : "string"
},
"merchantLegalName" : {
"description" : "Legal Business Name of the Merchant.",
"type" : "string"
},
"merchantShopUrl" : {
"description" : "Merchant shop url.",
"type" : "string"
},
"merchantStateProvince" : {
"description" : "The state/province of the merchant.",
"type" : "string"
},
"merchantStreetAddress" : {
"description" : "The street address of the merchant.",
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.\nx> You cannot configure the transaction description in the test environment.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
},
"zipCode" : {
"description" : "The zip code of the account.",
"type" : "string"
}
},
"type" : "object"
},
"PayMeInfo" : {
"additionalProperties" : false,
"properties" : {
@@ -18537,10 +18571,6 @@
"description" : "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
"type" : "boolean"
},
"giroPay" : {
"description" : "giropay details.",
"$ref" : "#/components/schemas/GiroPayInfo"
},
"girocard" : {
"description" : "Girocard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -18585,6 +18615,10 @@
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"paybybank_plaid" : {
"description" : "PayByBank Plaid details.",
"$ref" : "#/components/schemas/PayByBankPlaidInfo"
},
"payme" : {
"description" : "PayMe details.",
"$ref" : "#/components/schemas/PayMeInfo"
@@ -18758,12 +18792,12 @@
"nyce",
"onlineBanking_PL",
"paybybank",
"paybybank_plaid",
"payme",
"payme_pos",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"payto",
"pulse",
"sodexo",
@@ -18875,10 +18909,6 @@
"description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"giroPay" : {
"description" : "giropay details.",
"$ref" : "#/components/schemas/GiroPayInfo"
},
"girocard" : {
"description" : "Girocard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
@@ -18919,6 +18949,10 @@
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"paybybank_plaid" : {
"description" : "PayByBank Plaid details.",
"$ref" : "#/components/schemas/PayByBankPlaidInfo"
},
"payme" : {
"description" : "PayMe details.",
"$ref" : "#/components/schemas/PayMeInfo"
@@ -19037,12 +19071,12 @@
"nyce",
"onlineBanking_PL",
"paybybank",
"paybybank_plaid",
"payme",
"payme_pos",
"paynow",
"paynow_pos",
"paypal",
"payshop",
"payto",
"pulse",
"sodexo",
@@ -19194,6 +19228,10 @@
"description" : "Indicates whether this is your preferred wireless network. If **true**, the terminal will try connecting to this network first.",
"type" : "boolean"
},
"domainSuffix" : {
"description" : "Specifies the server domain name for EAP-TLS and EAP-PEAP WiFi profiles on Android 11 and above.",
"type" : "string"
},
"eap" : {
"description" : "For `authType` **wpa-eap** or **wpa2-eap**. Possible values: **tls**, **peap**, **leap**, **fast**",
"type" : "string"
@@ -19878,8 +19916,11 @@
"fundingSource" : {
"description" : "The funding source of the payment method. This only applies to card transactions.\n\nPossible values:\n* **credit**\n* **debit**\n* **prepaid**\n* **deferred_debit**\n* **charged**\n* **ANY**",
"enum" : [
"charged",
"credit",
"debit",
"deferred_debit",
"prepaid",
"ANY"
],
"type" : "string"
@@ -19926,6 +19967,10 @@
"minLength" : 3,
"type" : "string"
},
"enableGratuities" : {
"description" : "Indicates whether the tipping options specified in `gratuities` are enabled on the standalone terminal.",
"type" : "boolean"
},
"enableStandalone" : {
"description" : "Enable standalone mode.",
"type" : "boolean"
@@ -20819,7 +20864,7 @@
"type" : "string"
},
"output" : {
"description" : "The response your server returned for the test webhook.\n\nYour server must respond with **HTTP 2xx* for the test webhook to be successful (`data.status`: **success**). Find out more about [accepting notifications](https://docs.adyen.com/development-resources/webhooks#accept-notifications)\n\nYou can use the value of this field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot unsuccessful test webhooks.",
"description" : "A short, human-readable explanation of the test result.\n\nYour server must respond with **HTTP 2xx* for the test webhook to be successful (`data.status`: **success**). Find out more about [accepting notifications](https://docs.adyen.com/development-resources/webhooks#accept-notifications)\n\nYou can use the value of this field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot unsuccessful test webhooks.",
"type" : "string"
},
"requestSent" : {
@@ -21408,6 +21453,10 @@
"description" : "NYCE details.",
"$ref" : "#/components/schemas/NyceInfo"
},
"paybybank_plaid" : {
"description" : "PayByBank Plaid details.",
"$ref" : "#/components/schemas/PayByBankPlaidInfo"
},
"pulse" : {
"description" : "PULSE details.",
"$ref" : "#/components/schemas/PulseInfo"
@@ -21931,7 +21980,7 @@
"type" : "boolean"
},
"type" : {
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **direct-debit-notice-of-change**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n- **terminal-settings**\n- **terminal-boarding**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {

View File

@@ -10040,6 +10040,9 @@ components:
AfterpayTouchInfo:
additionalProperties: false
properties:
supportEmail:
description: Support Email
type: string
supportUrl:
description: Support Url
type: string
@@ -11072,6 +11075,8 @@ components:
- **ach-notification-of-change-notification**
- **direct-debit-notice-of-change**
- **pending-notification**
- **ideal-notification**
@@ -11341,6 +11346,8 @@ components:
- **ach-notification-of-change-notification**
- **direct-debit-notice-of-change**
- **pending-notification**
- **ideal-notification**
@@ -11660,15 +11667,6 @@ components:
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
type: object
GiroPayInfo:
additionalProperties: false
properties:
supportEmail:
description: The email address of merchant support.
type: string
required:
- supportEmail
type: object
GooglePayInfo:
additionalProperties: false
properties:
@@ -11801,7 +11799,10 @@ components:
properties:
midNumber:
description: 'MID (Merchant ID) number. Required for merchants operating
in Japan.Format: 14 numeric characters.'
in Japan or merchants operating in Canada, Australia and New Zealand when
requesting `gatewayContract` or `paymentDesignatorContract` service levels.Format:
14 numeric characters for Japan, 10 numeric characters for Canada, Australia
and New Zealand.'
maxLength: 14
type: string
reuseMidNumber:
@@ -11816,13 +11817,20 @@ components:
Possible values:
* **noContract**: Adyen holds the contract with JCB.
* **noContract**: Adyen holds the contract with JCB for merchants operating
in Japan or American Express for merchants operating in Canada, Australia
and New Zealand.
* **gatewayContract**: JCB receives the settlement and handles disputes,
then pays out to you or your sub-merchant directly.'
* **gatewayContract**: JCB or American Express receives the settlement
and handles disputes, then pays out to you or your sub-merchant directly.
* **paymentDesignatorContract**: Available only for merchants operating
in Canada, Australia and New Zealand. Adyen receives the settlement, and
handles disputes and payouts.'
enum:
- noContract
- gatewayContract
- paymentDesignatorContract
type: string
transactionDescription:
description: 'Information regarding the transaction description.
@@ -12568,6 +12576,39 @@ components:
nullable: true
type: string
type: object
PayByBankPlaidInfo:
additionalProperties: false
properties:
countryCode:
description: Country Code.
type: string
logo:
description: 'Merchant logo (max. size 150kB). Format: Base64-encoded string.'
type: string
merchantCity:
description: The city the merchant is doing business in.
type: string
merchantLegalName:
description: Legal Business Name of the Merchant.
type: string
merchantShopUrl:
description: Merchant shop url.
type: string
merchantStateProvince:
description: The state/province of the merchant.
type: string
merchantStreetAddress:
description: The street address of the merchant.
type: string
transactionDescription:
description: 'Information regarding the transaction description.
x> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
zipCode:
description: The zip code of the account.
type: string
type: object
PayMeInfo:
additionalProperties: false
properties:
@@ -12717,9 +12758,6 @@ components:
description: Indicates whether the payment method is enabled (**true**)
or disabled (**false**).
type: boolean
giroPay:
description: giropay details.
$ref: '#/components/schemas/GiroPayInfo'
girocard:
description: Girocard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -12759,6 +12797,9 @@ components:
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
paybybank_plaid:
description: PayByBank Plaid details.
$ref: '#/components/schemas/PayByBankPlaidInfo'
payme:
description: PayMe details.
$ref: '#/components/schemas/PayMeInfo'
@@ -12914,12 +12955,12 @@ components:
- nyce
- onlineBanking_PL
- paybybank
- paybybank_plaid
- payme
- payme_pos
- paynow
- paynow_pos
- paypal
- payshop
- payto
- pulse
- sodexo
@@ -13015,9 +13056,6 @@ components:
eftpos_australia:
description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
giroPay:
description: giropay details.
$ref: '#/components/schemas/GiroPayInfo'
girocard:
description: Girocard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -13054,6 +13092,9 @@ components:
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
paybybank_plaid:
description: PayByBank Plaid details.
$ref: '#/components/schemas/PayByBankPlaidInfo'
payme:
description: PayMe details.
$ref: '#/components/schemas/PayMeInfo'
@@ -13165,12 +13206,12 @@ components:
- nyce
- onlineBanking_PL
- paybybank
- paybybank_plaid
- payme
- payme_pos
- paynow
- paynow_pos
- paypal
- payshop
- payto
- pulse
- sodexo
@@ -13367,6 +13408,10 @@ components:
description: Indicates whether this is your preferred wireless network.
If **true**, the terminal will try connecting to this network first.
type: boolean
domainSuffix:
description: Specifies the server domain name for EAP-TLS and EAP-PEAP WiFi
profiles on Android 11 and above.
type: string
eap:
description: 'For `authType` **wpa-eap** or **wpa2-eap**. Possible values:
**tls**, **peap**, **leap**, **fast**'
@@ -14030,8 +14075,11 @@ components:
* **ANY**'
enum:
- charged
- credit
- debit
- deferred_debit
- prepaid
- ANY
type: string
paymentMethod:
@@ -14095,6 +14143,10 @@ components:
maxLength: 3
minLength: 3
type: string
enableGratuities:
description: Indicates whether the tipping options specified in `gratuities`
are enabled on the standalone terminal.
type: boolean
enableStandalone:
description: Enable standalone mode.
type: boolean
@@ -14789,7 +14841,7 @@ components:
is about.
type: string
output:
description: 'The response your server returned for the test webhook.
description: 'A short, human-readable explanation of the test result.
Your server must respond with **HTTP 2xx* for the test webhook to be successful
@@ -15397,6 +15449,9 @@ components:
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
paybybank_plaid:
description: PayByBank Plaid details.
$ref: '#/components/schemas/PayByBankPlaidInfo'
pulse:
description: PULSE details.
$ref: '#/components/schemas/PulseInfo'
@@ -15982,6 +16037,8 @@ components:
- **ach-notification-of-change-notification**
- **direct-debit-notice-of-change**
- **pending-notification**
- **ideal-notification**

View File

@@ -10298,6 +10298,9 @@ components:
AfterpayTouchInfo:
additionalProperties: false
properties:
supportEmail:
description: Support Email
type: string
supportUrl:
description: Support Url
type: string
@@ -11354,6 +11357,8 @@ components:
- **ach-notification-of-change-notification**
- **direct-debit-notice-of-change**
- **pending-notification**
- **ideal-notification**
@@ -11624,6 +11629,8 @@ components:
- **ach-notification-of-change-notification**
- **direct-debit-notice-of-change**
- **pending-notification**
- **ideal-notification**
@@ -11943,15 +11950,6 @@ components:
> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
type: object
GiroPayInfo:
additionalProperties: false
properties:
supportEmail:
description: The email address of merchant support.
type: string
required:
- supportEmail
type: object
GooglePayInfo:
additionalProperties: false
properties:
@@ -12080,7 +12078,10 @@ components:
properties:
midNumber:
description: 'MID (Merchant ID) number. Required for merchants operating
in Japan.Format: 14 numeric characters.'
in Japan or merchants operating in Canada, Australia and New Zealand when
requesting `gatewayContract` or `paymentDesignatorContract` service levels.Format:
14 numeric characters for Japan, 10 numeric characters for Canada, Australia
and New Zealand.'
maxLength: 14
type: string
reuseMidNumber:
@@ -12095,13 +12096,20 @@ components:
Possible values:
* **noContract**: Adyen holds the contract with JCB.
* **noContract**: Adyen holds the contract with JCB for merchants operating
in Japan or American Express for merchants operating in Canada, Australia
and New Zealand.
* **gatewayContract**: JCB receives the settlement and handles disputes,
then pays out to you or your sub-merchant directly.'
* **gatewayContract**: JCB or American Express receives the settlement
and handles disputes, then pays out to you or your sub-merchant directly.
* **paymentDesignatorContract**: Available only for merchants operating
in Canada, Australia and New Zealand. Adyen receives the settlement, and
handles disputes and payouts.'
enum:
- noContract
- gatewayContract
- paymentDesignatorContract
type: string
transactionDescription:
description: 'Information regarding the transaction description.
@@ -12847,6 +12855,39 @@ components:
nullable: true
type: string
type: object
PayByBankPlaidInfo:
additionalProperties: false
properties:
countryCode:
description: Country Code.
type: string
logo:
description: 'Merchant logo (max. size 150kB). Format: Base64-encoded string.'
type: string
merchantCity:
description: The city the merchant is doing business in.
type: string
merchantLegalName:
description: Legal Business Name of the Merchant.
type: string
merchantShopUrl:
description: Merchant shop url.
type: string
merchantStateProvince:
description: The state/province of the merchant.
type: string
merchantStreetAddress:
description: The street address of the merchant.
type: string
transactionDescription:
description: 'Information regarding the transaction description.
x> You cannot configure the transaction description in the test environment.'
$ref: '#/components/schemas/TransactionDescriptionInfo'
zipCode:
description: The zip code of the account.
type: string
type: object
PayMeInfo:
additionalProperties: false
properties:
@@ -12996,9 +13037,6 @@ components:
description: Indicates whether the payment method is enabled (**true**)
or disabled (**false**).
type: boolean
giroPay:
description: giropay details.
$ref: '#/components/schemas/GiroPayInfo'
girocard:
description: Girocard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -13038,6 +13076,9 @@ components:
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
paybybank_plaid:
description: PayByBank Plaid details.
$ref: '#/components/schemas/PayByBankPlaidInfo'
payme:
description: PayMe details.
$ref: '#/components/schemas/PayMeInfo'
@@ -13196,12 +13237,12 @@ components:
- nyce
- onlineBanking_PL
- paybybank
- paybybank_plaid
- payme
- payme_pos
- paynow
- paynow_pos
- paypal
- payshop
- payto
- pulse
- sodexo
@@ -13297,9 +13338,6 @@ components:
eftpos_australia:
description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
giroPay:
description: giropay details.
$ref: '#/components/schemas/GiroPayInfo'
girocard:
description: Girocard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
@@ -13336,6 +13374,9 @@ components:
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
paybybank_plaid:
description: PayByBank Plaid details.
$ref: '#/components/schemas/PayByBankPlaidInfo'
payme:
description: PayMe details.
$ref: '#/components/schemas/PayMeInfo'
@@ -13450,12 +13491,12 @@ components:
- nyce
- onlineBanking_PL
- paybybank
- paybybank_plaid
- payme
- payme_pos
- paynow
- paynow_pos
- paypal
- payshop
- payto
- pulse
- sodexo
@@ -13648,6 +13689,10 @@ components:
description: Indicates whether this is your preferred wireless network.
If **true**, the terminal will try connecting to this network first.
type: boolean
domainSuffix:
description: Specifies the server domain name for EAP-TLS and EAP-PEAP WiFi
profiles on Android 11 and above.
type: string
eap:
description: 'For `authType` **wpa-eap** or **wpa2-eap**. Possible values:
**tls**, **peap**, **leap**, **fast**'
@@ -14309,8 +14354,11 @@ components:
* **ANY**'
enum:
- charged
- credit
- debit
- deferred_debit
- prepaid
- ANY
type: string
paymentMethod:
@@ -14374,6 +14422,10 @@ components:
maxLength: 3
minLength: 3
type: string
enableGratuities:
description: Indicates whether the tipping options specified in `gratuities`
are enabled on the standalone terminal.
type: boolean
enableStandalone:
description: Enable standalone mode.
type: boolean
@@ -15224,7 +15276,7 @@ components:
is about.
type: string
output:
description: 'The response your server returned for the test webhook.
description: 'A short, human-readable explanation of the test result.
Your server must respond with **HTTP 2xx* for the test webhook to be successful
@@ -15834,6 +15886,9 @@ components:
nyce:
description: NYCE details.
$ref: '#/components/schemas/NyceInfo'
paybybank_plaid:
description: PayByBank Plaid details.
$ref: '#/components/schemas/PayByBankPlaidInfo'
pulse:
description: PULSE details.
$ref: '#/components/schemas/PulseInfo'
@@ -16460,6 +16515,8 @@ components:
- **ach-notification-of-change-notification**
- **direct-debit-notice-of-change**
- **pending-notification**
- **ideal-notification**