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
2023-09-04 09:50:21 +02:00
parent c94bd3564d
commit 8dc3d63d7d
4 changed files with 706 additions and 187 deletions
Download Patch File Download Diff File Expand all files Collapse all files

137
json/ManagementNotificationService-v1.json
View File

@@ -46,7 +46,7 @@
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationDataMessage"
"$ref" : "#/components/schemas/MerchantCreatedNotificationRequest"
}
}
}
@@ -100,7 +100,7 @@
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationDataMessage-type2"
"$ref" : "#/components/schemas/MerchantUpdatedNotificationRequest"
}
}
}
@@ -154,7 +154,7 @@
}
},
"schema" : {
"$ref" : "#/components/schemas/NotificationDataMessage-type3"
"$ref" : "#/components/schemas/PaymentMethodCreatedNotificationRequest"
}
}
}
@@ -365,6 +365,68 @@
],
"type" : "object"
},
"MerchantCreatedNotificationRequest" : {
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/AccountCreateNotificationData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"enum" : [
"merchant.created"
],
"type" : "string"
}
},
"required" : [
"environment",
"createdAt",
"data",
"type"
],
"type" : "object"
},
"MerchantUpdatedNotificationRequest" : {
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/AccountUpdateNotificationData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"enum" : [
"merchant.updated"
],
"type" : "string"
}
},
"required" : [
"environment",
"createdAt",
"data",
"type"
],
"type" : "object"
},
"MidServiceNotificationData" : {
"properties" : {
"allowed" : {
@@ -422,63 +484,7 @@
],
"type" : "object"
},
"NotificationDataMessage" : {
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/AccountCreateNotificationData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"type" : "string"
}
},
"required" : [
"type",
"environment",
"createdAt",
"data"
],
"type" : "object"
},
"NotificationDataMessage-type2" : {
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/AccountUpdateNotificationData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"type" : "string"
}
},
"required" : [
"type",
"environment",
"createdAt",
"data"
],
"type" : "object"
},
"NotificationDataMessage-type3" : {
"PaymentMethodCreatedNotificationRequest" : {
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
@@ -495,14 +501,17 @@
},
"type" : {
"description" : "Type of notification.",
"enum" : [
"paymentMethod.created"
],
"type" : "string"
}
},
"required" : [
"type",
"environment",
"createdAt",
"data"
"data",
"type"
],
"type" : "object"
},
@@ -605,7 +614,9 @@
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : "[accepted]"
"value" : {
"notificationResponse" : "[accepted]"
}
},
"post-merchant.created-merchant.created" : {
"summary" : "Merchant account created",

332
json/ManagementService-v1.json
View File

@@ -44,6 +44,7 @@
"Terminal settings - merchant level",
"Terminal settings - store level",
"Terminal settings - terminal level",
"Android files - company level",
"Split configuration - merchant level"
],
"tags" : [
@@ -113,6 +114,9 @@
{
"name" : "Terminals - terminal level"
},
{
"name" : "Android files - company level"
},
{
"name" : "Account - store level"
},
@@ -349,12 +353,12 @@
"/companies/{companyId}/androidApps" : {
"get" : {
"tags" : [
"Terminal actions - company level"
"Android files - company level"
],
"summary" : "Get a list of Android apps",
"description" : "Returns a list of the Android apps that are available for the company identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
"description" : "Returns a list of the Android apps that are available for the company identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
"operationId" : "get-companies-companyId-androidApps",
"x-groupName" : "Terminal actions - company level",
"x-groupName" : "Android files - company level",
"x-sortIndex" : 1,
"x-methodName" : "listAndroidApps",
"security" : [
@@ -486,15 +490,120 @@
}
}
},
"/companies/{companyId}/androidApps/{id}" : {
"get" : {
"tags" : [
"Android files - company level"
],
"summary" : "Get Android app",
"description" : "Returns the details of the Android app identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write",
"operationId" : "get-companies-companyId-androidApps-id",
"x-groupName" : "Android files - company level",
"x-sortIndex" : 3,
"x-methodName" : "getAndroidApp",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the company account.",
"name" : "companyId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "The unique identifier of the app.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AndroidApp"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/companies/{companyId}/androidCertificates" : {
"get" : {
"tags" : [
"Terminal actions - company level"
"Android files - company level"
],
"summary" : "Get a list of Android certificates",
"description" : "Returns a list of the Android certificates that are available for the company identified in the path.\nTypically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
"description" : "Returns a list of the Android certificates that are available for the company identified in the path.\nTypically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
"operationId" : "get-companies-companyId-androidCertificates",
"x-groupName" : "Terminal actions - company level",
"x-groupName" : "Android files - company level",
"x-sortIndex" : 2,
"x-methodName" : "listAndroidCertificates",
"security" : [
@@ -1366,7 +1475,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - the request has been successfully processed, but there is no additional content."
"description" : "No Content - look at the actual response code for the status of the request "
},
"400" : {
"content" : {
@@ -2231,7 +2340,7 @@
"description" : "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
"operationId" : "get-companies-companyId-terminalActions",
"x-groupName" : "Terminal actions - company level",
"x-sortIndex" : 3,
"x-sortIndex" : 1,
"x-methodName" : "listTerminalActions",
"security" : [
{
@@ -2370,7 +2479,7 @@
"description" : "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
"operationId" : "get-companies-companyId-terminalActions-actionId",
"x-groupName" : "Terminal actions - company level",
"x-sortIndex" : 4,
"x-sortIndex" : 2,
"x-methodName" : "getTerminalAction",
"security" : [
{
@@ -4495,7 +4604,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - the request has been successfully processed, but there is no additional content."
"description" : "No Content - look at the actual response code for the status of the request "
},
"400" : {
"content" : {
@@ -5310,7 +5419,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - the request has been successfully processed, but there is no additional content."
"description" : "No Content - look at the actual response code for the status of the request "
},
"400" : {
"content" : {
@@ -5789,7 +5898,7 @@
"Account - merchant level"
],
"summary" : "Request to activate a merchant account",
"description" : "Sends a request to activate the merchant account identified in the path.\n\nYou get the result of the activation asychronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write",
"description" : "Sends a request to activate the merchant account identified in the path.\n\nYou get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write",
"operationId" : "post-merchants-merchantId-activate",
"x-groupName" : "Account - merchant level",
"x-sortIndex" : 2,
@@ -6650,7 +6759,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - the request has been successfully processed, but there is no additional content."
"description" : "No Content - look at the actual response code for the status of the request "
},
"400" : {
"content" : {
@@ -7693,7 +7802,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - the request has been successfully processed, but there is no additional content."
"description" : "No Content - look at the actual response code for the status of the request "
},
"400" : {
"content" : {
@@ -8104,7 +8213,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - the request has been successfully processed, but there is no additional content."
"description" : "No Content - look at the actual response code for the status of the request "
},
"400" : {
"content" : {
@@ -12786,7 +12895,7 @@
],
"responses" : {
"204" : {
"description" : "No Content - the request has been successfully processed, but there is no additional content."
"description" : "No Content - look at the actual response code for the status of the request "
},
"400" : {
"content" : {
@@ -15118,6 +15227,10 @@
"description" : "The description that was provided when uploading the app. The description is not shown on the terminal.",
"type" : "string"
},
"errorCode" : {
"description" : "The error code of the app. It exists if the status is error or invalid.",
"type" : "string"
},
"id" : {
"description" : "The unique identifier of the app.",
"type" : "string"
@@ -15131,7 +15244,7 @@
"type" : "string"
},
"status" : {
"description" : "The status of the app. Possible values: \n* `processing`: The app is being signed and converted to a format that the terminal can handle.\n* `error`: Something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n* `invalid`: There is something wrong with the APK file of the app.\n* `ready`: The app has been signed and converted.\n* `archived`: The app is no longer available.",
"description" : "The status of the app. Possible values: \n* `processing`: the app is being signed and converted to a format that the terminal can handle.\n* `error`: something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n* `invalid`: there is something wrong with the APK file of the app.\n* `ready`: the app has been signed and converted.\n* `archived`: the app is no longer available.",
"type" : "string"
},
"versionCode" : {
@@ -15320,6 +15433,10 @@
"enableBcmcMobile" : {
"description" : "Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) is enabled.",
"type" : "boolean"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"type" : "object"
@@ -15375,6 +15492,10 @@
"siret" : {
"description" : "Cartes Bancaires SIRET. Format: 14 digits.",
"type" : "string"
},
"transactionDescription" : {
"description" : "Information regarding the transaction description.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"required" : [
@@ -16022,7 +16143,7 @@
"type" : "string"
},
"filterMerchantAccountType" : {
"description" : "Shows how merchant accounts are filtered when configuring the webhook. Possible values:\n* **includeAccounts**: The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`.\n* **excludeAccounts**: The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`.\n* **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.",
"description" : "Shows how merchant accounts are filtered when configuring the webhook. \n\nPossible values:\n* **allAccounts** : Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.\n* **includeAccounts** : The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`.\n* **excludeAccounts** : The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`.\n\n",
"enum" : [
"allAccounts",
"excludeAccounts",
@@ -16064,7 +16185,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- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\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- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\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" : {
@@ -16292,7 +16413,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- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\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- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\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" : {
@@ -16406,7 +16527,7 @@
"$ref" : "#/components/schemas/Amount"
},
"eventCode" : {
"description" : "The event that caused the notification to be sent.Currently supported values:\n* **AUTHORISATION**\n* **CANCELLATION**\n* **REFUND**\n* **CAPTURE**\n* **DEACTIVATE_RECURRING**\n* **REPORT_AVAILABLE**\n* **CHARGEBACK**\n* **REQUEST_FOR_INFORMATION**\n* **NOTIFICATION_OF_CHARGEBACK**\n* **NOTIFICATIONTEST**\n* **ORDER_OPENED**\n* **ORDER_CLOSED**\n* **CHARGEBACK_REVERSED**\n* **REFUNDED_REVERSED**\n* **REFUND_WITH_DATA**",
"description" : "The event that caused the notification to be sent.Currently supported values:\n* **AUTHORISATION**\n* **CANCELLATION**\n* **REFUND**\n* **CAPTURE**\n* **REPORT_AVAILABLE**\n* **CHARGEBACK**\n* **REQUEST_FOR_INFORMATION**\n* **NOTIFICATION_OF_CHARGEBACK**\n* **NOTIFICATIONTEST**\n* **ORDER_OPENED**\n* **ORDER_CLOSED**\n* **CHARGEBACK_REVERSED**\n* **REFUNDED_REVERSED**\n* **REFUND_WITH_DATA**",
"type" : "string"
},
"eventDate" : {
@@ -16557,6 +16678,15 @@
],
"type" : "object"
},
"GenericPmWithTdiInfo" : {
"properties" : {
"transactionDescription" : {
"description" : "Information regarding the transaction description.",
"$ref" : "#/components/schemas/TransactionDescriptionInfo"
}
},
"type" : "object"
},
"GiroPayInfo" : {
"properties" : {
"supportEmail" : {
@@ -17186,7 +17316,7 @@
"type" : "string"
},
"subTypes" : {
"description" : "The list of additional payment methods. Allowed values: **mealVoucher_FR_endenred**, **mealVoucher_FR_groupeup**, **mealVoucher_FR_natixis**, **mealVoucher_FR_sodexo**.",
"description" : "The list of additional payment methods. Allowed values: **mealVoucher_FR_edenred**, **mealVoucher_FR_groupeup**, **mealVoucher_FR_natixis**, **mealVoucher_FR_sodexo**.",
"items" : {
"type" : "string"
},
@@ -17590,6 +17720,10 @@
},
"type" : "array"
},
"cup" : {
"description" : "China Union Pay details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"currencies" : {
"description" : "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
"items" : {
@@ -17604,6 +17738,18 @@
},
"type" : "array"
},
"diners" : {
"description" : "Diners details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"discover" : {
"description" : "Discover details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : {
"description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"enabled" : {
"description" : "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
"type" : "boolean"
@@ -17612,6 +17758,10 @@
"description" : "giropay details.",
"$ref" : "#/components/schemas/GiroPayInfo"
},
"girocard" : {
"description" : "Girocard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"googlePay" : {
"description" : "Google Pay details.",
"$ref" : "#/components/schemas/GooglePayInfo"
@@ -17620,10 +17770,30 @@
"description" : "The identifier of the resource.",
"type" : "string"
},
"ideal" : {
"description" : "iDeal details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"interac_card" : {
"description" : "Interac Card details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"jcb" : {
"description" : "JCB details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"klarna" : {
"description" : "Klarna details.",
"$ref" : "#/components/schemas/KlarnaInfo"
},
"maestro" : {
"description" : "Maestro details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mc" : {
"description" : "MasterCard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mealVoucher_FR" : {
"description" : "Meal Voucher FR details.",
"$ref" : "#/components/schemas/MealVoucherFRInfo"
@@ -17674,6 +17844,10 @@
"vipps" : {
"description" : "Vipps details.",
"$ref" : "#/components/schemas/VippsInfo"
},
"visa" : {
"description" : "Visa details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}
},
"required" : [
@@ -17803,6 +17977,10 @@
},
"type" : "array"
},
"cup" : {
"description" : "China Union Pay details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"currencies" : {
"description" : "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
"items" : {
@@ -17817,18 +17995,54 @@
},
"type" : "array"
},
"diners" : {
"description" : "Diners details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"discover" : {
"description" : "Discover details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"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"
},
"googlePay" : {
"description" : "Google Pay details.",
"$ref" : "#/components/schemas/GooglePayInfo"
},
"ideal" : {
"description" : "iDeal details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"interac_card" : {
"description" : "Interac Card details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"jcb" : {
"description" : "JCB details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"klarna" : {
"description" : "Klarna details.",
"$ref" : "#/components/schemas/KlarnaInfo"
},
"maestro" : {
"description" : "Maestro details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mc" : {
"description" : "MasterCard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mealVoucher_FR" : {
"description" : "Meal Voucher FR details.",
"$ref" : "#/components/schemas/MealVoucherFRInfo"
@@ -17927,6 +18141,10 @@
"vipps" : {
"description" : "Vipps details.",
"$ref" : "#/components/schemas/VippsInfo"
},
"visa" : {
"description" : "Visa details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}
},
"type" : "object"
@@ -19303,6 +19521,26 @@
},
"type" : "object"
},
"TransactionDescriptionInfo" : {
"properties" : {
"doingBusinessAsName" : {
"description" : "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**.",
"maxLength" : 22,
"type" : "string"
},
"type" : {
"default" : "dynamic",
"description" : "The type of transaction description you want to use:\n- **fixed**: The transaction description set in this request is used for all payments with this payment method.\n- **append**: The transaction description set in this request is used as a base for all payments with this payment method. The [transaction description set in the request to process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.\n- **dynamic**: Only the [transaction description set in the request to process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method.",
"enum" : [
"append",
"dynamic",
"fixed"
],
"type" : "string"
}
},
"type" : "object"
},
"TwintInfo" : {
"properties" : {
"logo" : {
@@ -19705,6 +19943,10 @@
},
"type" : "array"
},
"cup" : {
"description" : "China Union Pay details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"currencies" : {
"description" : "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
"items" : {
@@ -19712,16 +19954,56 @@
},
"type" : "array"
},
"diners" : {
"description" : "Diners details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"discover" : {
"description" : "Discover details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"eftpos_australia" : {
"description" : "Eftpos Australia details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"enabled" : {
"description" : "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
"type" : "boolean"
},
"girocard" : {
"description" : "Girocard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"ideal" : {
"description" : "iDeal details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"interac_card" : {
"description" : "Interac Card details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"jcb" : {
"description" : "JCB details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"maestro" : {
"description" : "Maestro details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"mc" : {
"description" : "MasterCard details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
},
"storeIds" : {
"description" : "The list of stores for this payment method",
"items" : {
"type" : "string"
},
"type" : "array"
},
"visa" : {
"description" : "Visa details.",
"$ref" : "#/components/schemas/GenericPmWithTdiInfo"
}
},
"type" : "object"
@@ -20080,7 +20362,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- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\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- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\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" : {
@@ -26784,7 +27066,7 @@
"acceptsExpiredCertificate" : false,
"acceptsSelfSignedCertificate" : true,
"acceptsUntrustedRootCertificate" : true,
"certificateAlias" : "signed-test.adyen.com_2022",
"certificateAlias" : "signed-test.adyen.com_2023",
"populateSoapActionHeader" : false,
"additionalSettings" : {
"properties" : {
@@ -27519,7 +27801,7 @@
"acceptsExpiredCertificate" : false,
"acceptsSelfSignedCertificate" : true,
"acceptsUntrustedRootCertificate" : true,
"certificateAlias" : "signed-test.adyen.com_2022",
"certificateAlias" : "signed-test.adyen.com_2023",
"populateSoapActionHeader" : false,
"additionalSettings" : {
"properties" : {

115
yaml/ManagementNotificationService-v1.yaml
View File

@@ -44,7 +44,7 @@ webhooks:
merchant.created:
$ref: '#/components/examples/post-merchant.created-merchant.created'
schema:
$ref: '#/components/schemas/NotificationDataMessage'
$ref: '#/components/schemas/MerchantCreatedNotificationRequest'
responses:
'200':
content:
@@ -80,7 +80,7 @@ webhooks:
merchant-updated-with-errors:
$ref: '#/components/examples/post-merchant.updated-merchant-updated-with-errors'
schema:
$ref: '#/components/schemas/NotificationDataMessage-type2'
$ref: '#/components/schemas/MerchantUpdatedNotificationRequest'
responses:
'200':
content:
@@ -114,7 +114,7 @@ webhooks:
paymentMethod.created:
$ref: '#/components/examples/post-paymentMethod.created-paymentMethod.created'
schema:
$ref: '#/components/schemas/NotificationDataMessage-type3'
$ref: '#/components/schemas/PaymentMethodCreatedNotificationRequest'
responses:
'200':
content:
@@ -352,6 +352,58 @@ components:
type: string
required: []
type: object
MerchantCreatedNotificationRequest:
properties:
createdAt:
description: Timestamp for when the webhook was created.
format: date-time
type: string
data:
description: Contains event details.
$ref: '#/components/schemas/AccountCreateNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
enum:
- merchant.created
type: string
required:
- environment
- createdAt
- data
- type
type: object
MerchantUpdatedNotificationRequest:
properties:
createdAt:
description: Timestamp for when the webhook was created.
format: date-time
type: string
data:
description: Contains event details.
$ref: '#/components/schemas/AccountUpdateNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
enum:
- merchant.updated
type: string
required:
- environment
- createdAt
- data
- type
type: object
MidServiceNotificationData:
properties:
allowed:
@@ -406,55 +458,7 @@ components:
- id
- type
type: object
NotificationDataMessage:
properties:
createdAt:
description: Timestamp for when the webhook was created.
format: date-time
type: string
data:
description: Contains event details.
$ref: '#/components/schemas/AccountCreateNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
type: string
required:
- type
- environment
- createdAt
- data
type: object
NotificationDataMessage-type2:
properties:
createdAt:
description: Timestamp for when the webhook was created.
format: date-time
type: string
data:
description: Contains event details.
$ref: '#/components/schemas/AccountUpdateNotificationData'
environment:
description: 'The environment from which the webhook originated.
Possible values: **test**, **live**.'
type: string
type:
description: Type of notification.
type: string
required:
- type
- environment
- createdAt
- data
type: object
NotificationDataMessage-type3:
PaymentMethodCreatedNotificationRequest:
properties:
createdAt:
description: Timestamp for when the webhook was created.
@@ -471,12 +475,14 @@ components:
type: string
type:
description: Type of notification.
enum:
- paymentMethod.created
type: string
required:
- type
- environment
- createdAt
- data
- type
type: object
PaymentMethodNotificationResponse:
properties:
@@ -555,7 +561,8 @@ components:
examples:
WebhookAck:
summary: Acknowledge Webhook
value: '[accepted]'
value:
notificationResponse: '[accepted]'
post-merchant.created-merchant.created:
summary: Merchant account created
description: Example webhook when a merchant account was created

309
yaml/ManagementService-v1.yaml
View File

@@ -77,6 +77,7 @@ x-groups:
- Terminal settings - merchant level
- Terminal settings - store level
- Terminal settings - terminal level
- Android files - company level
- Split configuration - merchant level
tags:
- name: API key - merchant level
@@ -101,6 +102,7 @@ tags:
- name: Terminal settings - merchant level
- name: Webhooks - company level
- name: Terminals - terminal level
- name: Android files - company level
- name: Account - store level
- name: Terminal settings - company level
- name: API credentials - company level
@@ -246,7 +248,7 @@ paths:
/companies/{companyId}/androidApps:
get:
tags:
- Terminal actions - company level
- Android files - company level
summary: Get a list of Android apps
description: "Returns a list of the Android apps that are available for the\
\ company identified in the path. \nThese apps have been uploaded to Adyen\
@@ -254,10 +256,11 @@ paths:
\ [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\
\nTo make this request, your API credential must have one of the following\
\ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Terminal actions read\n* Management API\u2014Terminal\
\ actions read and write"
* Management API\u2014Android files read\n* Management API\u2014Android files\
\ read and write\n* Management API\u2014Terminal actions read\n* Management\
\ API\u2014Terminal actions read and write"
operationId: get-companies-companyId-androidApps
x-groupName: Terminal actions - company level
x-groupName: Android files - company level
x-sortIndex: 1
x-methodName: listAndroidApps
security:
@@ -338,10 +341,79 @@ paths:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/companies/{companyId}/androidApps/{id}:
get:
tags:
- Android files - company level
summary: Get Android app
description: "Returns the details of the Android app identified in the path.\
\ \nThese apps have been uploaded to Adyen and can be installed or uninstalled\
\ on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\
\nTo make this request, your API credential must have one of the following\
\ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Android files read\n* Management API\u2014Android files\
\ read and write"
operationId: get-companies-companyId-androidApps-id
x-groupName: Android files - company level
x-sortIndex: 3
x-methodName: getAndroidApp
security:
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: The unique identifier of the company account.
name: companyId
in: path
required: true
schema:
type: string
- description: The unique identifier of the app.
name: id
in: path
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AndroidApp'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/companies/{companyId}/androidCertificates:
get:
tags:
- Terminal actions - company level
- Android files - company level
summary: Get a list of Android certificates
description: "Returns a list of the Android certificates that are available\
\ for the company identified in the path.\nTypically, these certificates enable\
@@ -350,10 +422,11 @@ paths:
\ through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\
\nTo make this request, your API credential must have one of the following\
\ [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\
* Management API\u2014Terminal actions read\n* Management API\u2014Terminal\
\ actions read and write"
* Management API\u2014Android files read\n* Management API\u2014Android files\
\ read and write\n* Management API\u2014Terminal actions read\n* Management\
\ API\u2014Terminal actions read and write"
operationId: get-companies-companyId-androidCertificates
x-groupName: Terminal actions - company level
x-groupName: Android files - company level
x-sortIndex: 2
x-methodName: listAndroidCertificates
security:
@@ -914,8 +987,8 @@ paths:
type: string
responses:
'204':
description: No Content - the request has been successfully processed, but
there is no additional content.
description: 'No Content - look at the actual response code for the status
of the request '
'400':
content:
application/json:
@@ -1476,7 +1549,7 @@ paths:
\ actions read and write"
operationId: get-companies-companyId-terminalActions
x-groupName: Terminal actions - company level
x-sortIndex: 3
x-sortIndex: 1
x-methodName: listTerminalActions
security:
- BasicAuth: []
@@ -1570,7 +1643,7 @@ paths:
\ actions read and write"
operationId: get-companies-companyId-terminalActions-actionId
x-groupName: Terminal actions - company level
x-sortIndex: 4
x-sortIndex: 2
x-methodName: getTerminalAction
security:
- BasicAuth: []
@@ -2952,8 +3025,8 @@ paths:
type: string
responses:
'204':
description: No Content - the request has been successfully processed, but
there is no additional content.
description: 'No Content - look at the actual response code for the status
of the request '
'400':
content:
application/json:
@@ -3487,8 +3560,8 @@ paths:
type: string
responses:
'204':
description: No Content - the request has been successfully processed, but
there is no additional content.
description: 'No Content - look at the actual response code for the status
of the request '
'400':
content:
application/json:
@@ -3795,7 +3868,7 @@ paths:
- Account - merchant level
summary: Request to activate a merchant account
description: "Sends a request to activate the merchant account identified in\
\ the path.\n\nYou get the result of the activation asychronously through\
\ the path.\n\nYou get the result of the activation asynchronously through\
\ a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated)\
\ webhook. Once the merchant account is activated, you can start using it\
\ to accept payments and payouts.\n\nUse this endpoint if your integration\
@@ -4360,8 +4433,8 @@ paths:
type: string
responses:
'204':
description: No Content - the request has been successfully processed, but
there is no additional content.
description: 'No Content - look at the actual response code for the status
of the request '
'400':
content:
application/json:
@@ -5036,8 +5109,8 @@ paths:
type: string
responses:
'204':
description: No Content - the request has been successfully processed, but
there is no additional content.
description: 'No Content - look at the actual response code for the status
of the request '
'400':
content:
application/json:
@@ -5308,8 +5381,8 @@ paths:
type: string
responses:
'204':
description: No Content - the request has been successfully processed, but
there is no additional content.
description: 'No Content - look at the actual response code for the status
of the request '
'400':
content:
application/json:
@@ -8387,8 +8460,8 @@ paths:
type: string
responses:
'204':
description: No Content - the request has been successfully processed, but
there is no additional content.
description: 'No Content - look at the actual response code for the status
of the request '
'400':
content:
application/json:
@@ -9953,6 +10026,10 @@ components:
description: The description that was provided when uploading the app. The
description is not shown on the terminal.
type: string
errorCode:
description: The error code of the app. It exists if the status is error
or invalid.
type: string
id:
description: The unique identifier of the app.
type: string
@@ -9964,11 +10041,11 @@ components:
type: string
status:
description: "The status of the app. Possible values: \n* `processing`:\
\ The app is being signed and converted to a format that the terminal\
\ can handle.\n* `error`: Something went wrong. Check that the app matches\
\ the app is being signed and converted to a format that the terminal\
\ can handle.\n* `error`: something went wrong. Check that the app matches\
\ the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n\
* `invalid`: There is something wrong with the APK file of the app.\n\
* `ready`: The app has been signed and converted.\n* `archived`: The app\
* `invalid`: there is something wrong with the APK file of the app.\n\
* `ready`: the app has been signed and converted.\n* `archived`: the app\
\ is no longer available."
type: string
versionCode:
@@ -10127,6 +10204,9 @@ components:
description: Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile)
is enabled.
type: boolean
transactionDescription:
description: Information regarding the transaction description.
$ref: '#/components/schemas/TransactionDescriptionInfo'
type: object
BillingEntitiesResponse:
properties:
@@ -10169,6 +10249,9 @@ components:
siret:
description: 'Cartes Bancaires SIRET. Format: 14 digits.'
type: string
transactionDescription:
description: Information regarding the transaction description.
$ref: '#/components/schemas/TransactionDescriptionInfo'
required:
- siret
type: object
@@ -10743,17 +10826,13 @@ components:
description: Your description for this webhook configuration.
type: string
filterMerchantAccountType:
description: 'Shows how merchant accounts are filtered when configuring
the webhook. Possible values:
* **includeAccounts**: The webhook is configured for the merchant accounts
listed in `filterMerchantAccounts`.
* **excludeAccounts**: The webhook is not configured for the merchant
accounts listed in `filterMerchantAccounts`.
* **allAccounts**: Includes all merchant accounts, and does not require
specifying `filterMerchantAccounts`.'
description: "Shows how merchant accounts are filtered when configuring\
\ the webhook. \n\nPossible values:\n* **allAccounts** : Includes all\
\ merchant accounts, and does not require specifying `filterMerchantAccounts`.\n\
* **includeAccounts** : The webhook is configured for the merchant accounts\
\ listed in `filterMerchantAccounts`.\n* **excludeAccounts** : The webhook\
\ is not configured for the merchant accounts listed in `filterMerchantAccounts`.\n\
\n"
enum:
- allAccounts
- excludeAccounts
@@ -10833,6 +10912,8 @@ components:
- **directdebit-notification**
- **ach-notification-of-change-notification**
- **pending-notification**
- **ideal-notification**
@@ -11084,6 +11165,8 @@ components:
- **directdebit-notification**
- **ach-notification-of-change-notification**
- **pending-notification**
- **ideal-notification**
@@ -11198,8 +11281,6 @@ components:
* **CAPTURE**
* **DEACTIVATE_RECURRING**
* **REPORT_AVAILABLE**
* **CHARGEBACK**
@@ -11340,6 +11421,12 @@ components:
required:
- hmacKey
type: object
GenericPmWithTdiInfo:
properties:
transactionDescription:
description: Information regarding the transaction description.
$ref: '#/components/schemas/TransactionDescriptionInfo'
type: object
GiroPayInfo:
properties:
supportEmail:
@@ -11829,7 +11916,7 @@ components:
minLength: 14
type: string
subTypes:
description: 'The list of additional payment methods. Allowed values: **mealVoucher_FR_endenred**,
description: 'The list of additional payment methods. Allowed values: **mealVoucher_FR_edenred**,
**mealVoucher_FR_groupeup**, **mealVoucher_FR_natixis**, **mealVoucher_FR_sodexo**.'
items:
type: string
@@ -12179,6 +12266,9 @@ components:
items:
type: string
type: array
cup:
description: China Union Pay details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
currencies:
description: The list of currencies that a payment method supports. By default,
all currencies supported by the payment method.
@@ -12191,6 +12281,15 @@ components:
items:
type: string
type: array
diners:
description: Diners details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
discover:
description: Discover details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia:
description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
enabled:
description: Indicates whether the payment method is enabled (**true**)
or disabled (**false**).
@@ -12198,15 +12297,33 @@ components:
giroPay:
description: giropay details.
$ref: '#/components/schemas/GiroPayInfo'
girocard:
description: Girocard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
googlePay:
description: Google Pay details.
$ref: '#/components/schemas/GooglePayInfo'
id:
description: The identifier of the resource.
type: string
ideal:
description: iDeal details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
interac_card:
description: Interac Card details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
jcb:
description: JCB details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
klarna:
description: Klarna details.
$ref: '#/components/schemas/KlarnaInfo'
maestro:
description: Maestro details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mc:
description: MasterCard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mealVoucher_FR:
description: Meal Voucher FR details.
$ref: '#/components/schemas/MealVoucherFRInfo'
@@ -12256,6 +12373,9 @@ components:
vipps:
description: Vipps details.
$ref: '#/components/schemas/VippsInfo'
visa:
description: Visa details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
required:
- id
type: object
@@ -12363,6 +12483,9 @@ components:
items:
type: string
type: array
cup:
description: China Union Pay details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
currencies:
description: The list of currencies that a payment method supports. By default,
all currencies supported by the payment method.
@@ -12375,15 +12498,42 @@ components:
items:
type: string
type: array
diners:
description: Diners details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
discover:
description: Discover details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
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'
googlePay:
description: Google Pay details.
$ref: '#/components/schemas/GooglePayInfo'
ideal:
description: iDeal details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
interac_card:
description: Interac Card details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
jcb:
description: JCB details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
klarna:
description: Klarna details.
$ref: '#/components/schemas/KlarnaInfo'
maestro:
description: Maestro details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mc:
description: MasterCard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mealVoucher_FR:
description: Meal Voucher FR details.
$ref: '#/components/schemas/MealVoucherFRInfo'
@@ -12478,6 +12628,9 @@ components:
vipps:
description: Vipps details.
$ref: '#/components/schemas/VippsInfo'
visa:
description: Visa details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
type: object
PaymentMethodWrapper:
properties:
@@ -13817,6 +13970,37 @@ components:
format: int32
type: integer
type: object
TransactionDescriptionInfo:
properties:
doingBusinessAsName:
description: "The text to be shown on the shopper's bank statement.\n We\
\ recommend sending a maximum of 22 characters, otherwise banks might\
\ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
\ spaces, and special characters **. , ' _ - ? + * /**."
maxLength: 22
type: string
type:
default: dynamic
description: 'The type of transaction description you want to use:
- **fixed**: The transaction description set in this request is used for
all payments with this payment method.
- **append**: The transaction description set in this request is used
as a base for all payments with this payment method. The [transaction
description set in the request to process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement)
is appended to this base description. Note that if the combined length
exceeds 22 characters, banks may truncate the string.
- **dynamic**: Only the [transaction description set in the request to
process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement)
is used for payments with this payment method.'
enum:
- append
- dynamic
- fixed
type: string
type: object
TwintInfo:
properties:
logo:
@@ -14222,21 +14406,54 @@ components:
items:
type: string
type: array
cup:
description: China Union Pay details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
currencies:
description: The list of currencies that a payment method supports. By default,
all currencies supported by the payment method.
items:
type: string
type: array
diners:
description: Diners details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
discover:
description: Discover details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
eftpos_australia:
description: Eftpos Australia details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
enabled:
description: Indicates whether the payment method is enabled (**true**)
or disabled (**false**).
type: boolean
girocard:
description: Girocard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
ideal:
description: iDeal details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
interac_card:
description: Interac Card details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
jcb:
description: JCB details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
maestro:
description: Maestro details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
mc:
description: MasterCard details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
storeIds:
description: The list of stores for this payment method
items:
type: string
type: array
visa:
description: Visa details.
$ref: '#/components/schemas/GenericPmWithTdiInfo'
type: object
UpdatePayoutSettingsRequest:
properties:
@@ -14638,6 +14855,8 @@ components:
- **directdebit-notification**
- **ach-notification-of-change-notification**
- **pending-notification**
- **ideal-notification**
@@ -19544,7 +19763,7 @@ components:
acceptsExpiredCertificate: false
acceptsSelfSignedCertificate: true
acceptsUntrustedRootCertificate: true
certificateAlias: signed-test.adyen.com_2022
certificateAlias: signed-test.adyen.com_2023
populateSoapActionHeader: false
additionalSettings:
properties:
@@ -20111,7 +20330,7 @@ components:
acceptsExpiredCertificate: false
acceptsSelfSignedCertificate: true
acceptsUntrustedRootCertificate: true
certificateAlias: signed-test.adyen.com_2022
certificateAlias: signed-test.adyen.com_2023
populateSoapActionHeader: false
additionalSettings:
properties: