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
2025-04-29 17:22:34 +02:00
parent c79d774ed5
commit 582242bc96
6 changed files with 343 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
json/BalancePlatformConfigurationNotification-v1.json
View File

@@ -889,7 +889,7 @@
"type" : "array" "type" : "array"
}, },
"defaultCurrencyCode" : { "defaultCurrencyCode" : {
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency.", "description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency.",
"type" : "string" "type" : "string"
}, },
"description" : { "description" : {
@@ -1612,6 +1612,14 @@
"maxLength" : 150, "maxLength" : 150,
"type" : "string" "type" : "string"
}, },
"replacedById" : {
"description" : "The unique identifier of the payment instrument that replaced this payment instrument.",
"type" : "string"
},
"replacementOfId" : {
"description" : "The unique identifier of the payment instrument that is replaced by this payment instrument.",
"type" : "string"
},
"status" : { "status" : {
"description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **Active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **Requested**.\n\nPossible values: \n\n * **Active**: The payment instrument is active and can be used to make payments. \n\n * **Requested**: The payment instrument has been requested. This state is applicable for physical cards. \n\n* **Inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. \n\n * **Closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n* **Stolen** \n\n * **Lost**\n\n ", "description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **Active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **Requested**.\n\nPossible values: \n\n * **Active**: The payment instrument is active and can be used to make payments. \n\n * **Requested**: The payment instrument has been requested. This state is applicable for physical cards. \n\n* **Inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. \n\n * **Closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n* **Stolen** \n\n * **Lost**\n\n ",
"enum" : [ "enum" : [

12
json/BalancePlatformConfigurationNotification-v2.json
View File

@@ -907,7 +907,7 @@
"type" : "array" "type" : "array"
}, },
"defaultCurrencyCode" : { "defaultCurrencyCode" : {
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency.", "description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency.",
"type" : "string" "type" : "string"
}, },
"description" : { "description" : {
@@ -1669,6 +1669,14 @@
"maxLength" : 150, "maxLength" : 150,
"type" : "string" "type" : "string"
}, },
"replacedById" : {
"description" : "The unique identifier of the payment instrument that replaced this payment instrument.",
"type" : "string"
},
"replacementOfId" : {
"description" : "The unique identifier of the payment instrument that is replaced by this payment instrument.",
"type" : "string"
},
"status" : { "status" : {
"description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n", "description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n",
"enum" : [ "enum" : [
@@ -1940,7 +1948,7 @@
}, },
"priorities" : { "priorities" : {
"x-addedInVersion" : "2", "x-addedInVersion" : "2",
"description" : "The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority you list first. If that's not possible, it moves on to the next option in the order of your provided priorities.\n\nPossible values:\n\n* **regular**: for normal, low-value transactions.\n\n* **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).\n\nSet `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).", "description" : "The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on.\n\nThe request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed.\n\nPossible values:\n\n* **regular**: for normal, low-value transactions.\n\n* **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).\n\nSet `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).",
"items" : { "items" : {
"enum" : [ "enum" : [
"crossBorder", "crossBorder",

202
json/BalancePlatformService-v2.json
View File

@@ -6527,8 +6527,8 @@
"/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings" : { "/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings" : {
"get" : { "get" : {
"tags" : [ "Balances" ], "tags" : [ "Balances" ],
"summary" : "Get webhook settings", "summary" : "Get all balance webhook settings",
"description" : "Returns all settings configured for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).", "description" : "Returns all balance webhook settings configured for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).",
"operationId" : "get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings", "operationId" : "get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings",
"parameters" : [ { "parameters" : [ {
"name" : "balancePlatformId", "name" : "balancePlatformId",
@@ -6557,44 +6557,43 @@
"content" : { "content" : {
"application/json" : { "application/json" : {
"schema" : { "schema" : {
"type" : "array", "$ref" : "#/components/schemas/WebhookSettings"
"items" : {
"$ref" : "#/components/schemas/WebhookSettingResponse"
}
}, },
"examples" : { "examples" : {
"get-webhook-settings-200" : { "get-webhook-settings-200" : {
"summary" : "Get all webhook settings", "summary" : "Get all webhook settings",
"description" : "Retrieve all settings of a webhook", "description" : "Retrieve all settings of a webhook",
"value" : [ { "value" : {
"id" : "BWHS00000000000000000000000001", "WebhookSettings" : [ {
"type" : "balance", "id" : "BWHS00000000000000000000000001",
"target" : { "type" : "balance",
"type" : "balancePlatform", "target" : {
"id" : "YOUR_BALANCE_PLATFORM" "type" : "balancePlatform",
}, "id" : "YOUR_BALANCE_PLATFORM"
"currency" : "USD", },
"status" : "active", "currency" : "USD",
"conditions" : [ { "status" : "active",
"balanceType" : "available", "conditions" : [ {
"conditionType" : "lessThan", "balanceType" : "available",
"value" : 500000 "conditionType" : "lessThan",
"value" : 500000
} ]
}, {
"id" : "BWHS00000000000000000000000002",
"type" : "balance",
"target" : {
"type" : "balanceAccount",
"id" : "BA00000000000000000LIABLE"
},
"currency" : "USD",
"status" : "active",
"conditions" : [ {
"balanceType" : "available",
"conditionType" : "greaterThan",
"value" : 1000000
} ]
} ] } ]
}, { }
"id" : "BWHS00000000000000000000000002",
"type" : "balance",
"target" : {
"type" : "balanceAccount",
"id" : "BA00000000000000000LIABLE"
},
"currency" : "USD",
"status" : "active",
"conditions" : [ {
"balanceType" : "available",
"conditionType" : "greaterThan",
"value" : 1000000
} ]
} ]
} }
} }
} }
@@ -6661,6 +6660,7 @@
} }
} }
}, },
"x-methodName" : "getAllWebhookSettings",
"x-sortIndex" : 4 "x-sortIndex" : 4
}, },
"post" : { "post" : {
@@ -6693,7 +6693,7 @@
"content" : { "content" : {
"application/json" : { "application/json" : {
"schema" : { "schema" : {
"$ref" : "#/components/schemas/BalanceWebhookSettingsRequest" "$ref" : "#/components/schemas/BalanceWebhookSettingInfo"
}, },
"examples" : { "examples" : {
"create-webhook-setting" : { "create-webhook-setting" : {
@@ -6725,7 +6725,7 @@
"content" : { "content" : {
"application/json" : { "application/json" : {
"schema" : { "schema" : {
"$ref" : "#/components/schemas/WebhookSettingResponse" "$ref" : "#/components/schemas/WebhookSetting"
}, },
"examples" : { "examples" : {
"create-webhook-setting" : { "create-webhook-setting" : {
@@ -6812,14 +6812,15 @@
} }
} }
}, },
"x-methodName" : "createWebhookSetting",
"x-sortIndex" : 1 "x-sortIndex" : 1
} }
}, },
"/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}" : { "/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}" : {
"get" : { "get" : {
"tags" : [ "Balances" ], "tags" : [ "Balances" ],
"summary" : "Get a webhook setting", "summary" : "Get a balance webhook setting by id",
"description" : "Returns the details of a specific balance webhook setting configured for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).", "description" : "Returns the details of a specific balance webhook setting configured for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).",
"operationId" : "get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId", "operationId" : "get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId",
"parameters" : [ { "parameters" : [ {
"name" : "balancePlatformId", "name" : "balancePlatformId",
@@ -6858,7 +6859,7 @@
"content" : { "content" : {
"application/json" : { "application/json" : {
"schema" : { "schema" : {
"$ref" : "#/components/schemas/WebhookSettingResponse" "$ref" : "#/components/schemas/WebhookSetting"
}, },
"examples" : { "examples" : {
"get-webhook-setting-by-id-200" : { "get-webhook-setting-by-id-200" : {
@@ -6945,12 +6946,13 @@
} }
} }
}, },
"x-methodName" : "getWebhookSetting",
"x-sortIndex" : 3 "x-sortIndex" : 3
}, },
"delete" : { "delete" : {
"tags" : [ "Balances" ], "tags" : [ "Balances" ],
"summary" : "Delete a webhook setting", "summary" : "Delete a balance webhook setting by id",
"description" : "Deletes a setting that contains the conditions for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).", "description" : "Deletes a balance webhook setting that contains the conditions for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).",
"operationId" : "delete-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId", "operationId" : "delete-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId",
"parameters" : [ { "parameters" : [ {
"name" : "balancePlatformId", "name" : "balancePlatformId",
@@ -6984,8 +6986,8 @@
} }
} ], } ],
"responses" : { "responses" : {
"200" : { "204" : {
"description" : "OK - the request has succeeded.", "description" : "No Content - the request has been successfully processed, but there is no additional content.",
"content" : { "content" : {
"application/json" : { } "application/json" : { }
} }
@@ -7051,12 +7053,13 @@
} }
} }
}, },
"x-methodName" : "deleteWebhookSetting",
"x-sortIndex" : 5 "x-sortIndex" : 5
}, },
"patch" : { "patch" : {
"tags" : [ "Balances" ], "tags" : [ "Balances" ],
"summary" : "Update a webhook setting", "summary" : "Update a balance webhook setting by id",
"description" : "Updates the conditions the balance change needs to meet for Adyen to send a [balance webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).", "description" : "Updates the conditions the balance change needs to meet for Adyen to send a [balance webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).",
"operationId" : "patch-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId", "operationId" : "patch-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId",
"parameters" : [ { "parameters" : [ {
"name" : "balancePlatformId", "name" : "balancePlatformId",
@@ -7093,7 +7096,7 @@
"content" : { "content" : {
"application/json" : { "application/json" : {
"schema" : { "schema" : {
"$ref" : "#/components/schemas/PatchableBalanceWebhookSettingsRequest" "$ref" : "#/components/schemas/BalanceWebhookSettingInfoUpdate"
}, },
"examples" : { "examples" : {
"update-webhook-setting" : { "update-webhook-setting" : {
@@ -7137,7 +7140,7 @@
"content" : { "content" : {
"application/json" : { "application/json" : {
"schema" : { "schema" : {
"$ref" : "#/components/schemas/WebhookSettingResponse" "$ref" : "#/components/schemas/WebhookSetting"
}, },
"examples" : { "examples" : {
"update-webhook-setting" : { "update-webhook-setting" : {
@@ -7251,6 +7254,7 @@
} }
} }
}, },
"x-methodName" : "updateWebhookSetting",
"x-sortIndex" : 2 "x-sortIndex" : 2
} }
} }
@@ -7925,7 +7929,7 @@
}, },
"defaultCurrencyCode" : { "defaultCurrencyCode" : {
"type" : "string", "type" : "string",
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency." "description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency."
}, },
"description" : { "description" : {
"type" : "string", "type" : "string",
@@ -7979,7 +7983,7 @@
}, },
"defaultCurrencyCode" : { "defaultCurrencyCode" : {
"type" : "string", "type" : "string",
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency." "description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency."
}, },
"description" : { "description" : {
"type" : "string", "type" : "string",
@@ -8033,7 +8037,7 @@
}, },
"defaultCurrencyCode" : { "defaultCurrencyCode" : {
"type" : "string", "type" : "string",
"description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency." "description" : "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area.\nThe default value is **EUR**.\n> After a balance account is created, you cannot change its default currency."
}, },
"description" : { "description" : {
"type" : "string", "type" : "string",
@@ -8999,7 +9003,7 @@
}, },
"priorities" : { "priorities" : {
"type" : "array", "type" : "array",
"description" : "The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority you list first. If that's not possible, it moves on to the next option in the order of your provided priorities.\n\nPossible values:\n\n* **regular**: for normal, low-value transactions.\n\n* **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).\n\nSet `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).", "description" : "The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on.\n\nThe request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed.\n\nPossible values:\n\n* **regular**: for normal, low-value transactions.\n\n* **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).\n\nSet `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).",
"items" : { "items" : {
"type" : "string", "type" : "string",
"enum" : [ "crossBorder", "fast", "instant", "internal", "regular", "wire" ] "enum" : [ "crossBorder", "fast", "instant", "internal", "regular", "wire" ]
@@ -10001,6 +10005,14 @@
"description" : "Your reference for the payment instrument, maximum 150 characters.", "description" : "Your reference for the payment instrument, maximum 150 characters.",
"maxLength" : 150 "maxLength" : 150
}, },
"replacedById" : {
"type" : "string",
"description" : "The unique identifier of the payment instrument that replaced this payment instrument."
},
"replacementOfId" : {
"type" : "string",
"description" : "The unique identifier of the payment instrument that is replaced by this payment instrument."
},
"status" : { "status" : {
"type" : "string", "type" : "string",
"description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n", "description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n",
@@ -10760,7 +10772,7 @@
}, },
"priorities" : { "priorities" : {
"type" : "array", "type" : "array",
"description" : "The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority you list first. If that's not possible, it moves on to the next option in the order of your provided priorities.\n\nPossible values:\n\n* **regular**: for normal, low-value transactions.\n\n* **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).\n\nSet `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).", "description" : "The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on.\n\nThe request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed.\n\nPossible values:\n\n* **regular**: for normal, low-value transactions.\n\n* **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).\n\nSet `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).",
"items" : { "items" : {
"type" : "string", "type" : "string",
"enum" : [ "crossBorder", "fast", "instant", "internal", "regular", "wire" ] "enum" : [ "crossBorder", "fast", "instant", "internal", "regular", "wire" ]
@@ -11225,6 +11237,14 @@
"totalAmount" : { "totalAmount" : {
"$ref" : "#/components/schemas/TotalAmountRestriction", "$ref" : "#/components/schemas/TotalAmountRestriction",
"description" : "The total amount and the operation.\n\nSupported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**." "description" : "The total amount and the operation.\n\nSupported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**."
},
"walletProviderAccountScore" : {
"$ref" : "#/components/schemas/WalletProviderAccountScoreRestriction",
"description" : "Checks the wallet account score.\n\nSupported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**."
},
"walletProviderDeviceScore" : {
"$ref" : "#/components/schemas/WalletProviderDeviceScore",
"description" : "Wallet Provider Device Score and the operation.\n\nSupported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**."
} }
} }
}, },
@@ -11492,6 +11512,14 @@
"description" : "Your reference for the payment instrument, maximum 150 characters.", "description" : "Your reference for the payment instrument, maximum 150 characters.",
"maxLength" : 150 "maxLength" : 150
}, },
"replacedById" : {
"type" : "string",
"description" : "The unique identifier of the payment instrument that replaced this payment instrument."
},
"replacementOfId" : {
"type" : "string",
"description" : "The unique identifier of the payment instrument that is replaced by this payment instrument."
},
"status" : { "status" : {
"type" : "string", "type" : "string",
"description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n", "description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n",
@@ -11545,7 +11573,7 @@
}, },
"priorities" : { "priorities" : {
"type" : "array", "type" : "array",
"description" : "The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority you list first. If that's not possible, it moves on to the next option in the order of your provided priorities.\n\nPossible values:\n\n* **regular**: for normal, low-value transactions.\n\n* **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).\n\nSet `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).", "description" : "The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on.\n\nThe request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed.\n\nPossible values:\n\n* **regular**: for normal, low-value transactions.\n\n* **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).\n\nSet `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).",
"items" : { "items" : {
"type" : "string", "type" : "string",
"enum" : [ "crossBorder", "fast", "instant", "internal", "regular", "wire" ] "enum" : [ "crossBorder", "fast", "instant", "internal", "regular", "wire" ]
@@ -11707,7 +11735,37 @@
} }
} }
}, },
"BalanceWebhookSettingsRequest" : { "WalletProviderAccountScoreRestriction" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"type" : "string",
"description" : "Defines how the condition must be evaluated."
},
"value" : {
"type" : "integer",
"format" : "int32"
}
},
"required" : [ "operation" ]
},
"WalletProviderDeviceScore" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"type" : "string",
"description" : "Defines how the condition must be evaluated."
},
"value" : {
"type" : "integer",
"format" : "int32"
}
},
"required" : [ "operation" ]
},
"BalanceWebhookSettingInfo" : {
"type" : "object", "type" : "object",
"properties" : { "properties" : {
"conditions" : { "conditions" : {
@@ -11780,16 +11838,16 @@
}, },
"required" : [ "id", "type" ] "required" : [ "id", "type" ]
}, },
"BalanceWebhookSettingsResponse" : { "BalanceWebhookSetting" : {
"type" : "object", "type" : "object",
"allOf" : [ { "allOf" : [ {
"$ref" : "#/components/schemas/WebhookSettingResponse" "$ref" : "#/components/schemas/WebhookSetting"
}, { }, {
"type" : "object", "type" : "object",
"properties" : { "properties" : {
"conditions" : { "conditions" : {
"type" : "array", "type" : "array",
"description" : "The list of settings and criteria for triggering the [balance webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated).", "description" : "The list of settings and criteria for triggering the [balance webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).",
"items" : { "items" : {
"$ref" : "#/components/schemas/Condition" "$ref" : "#/components/schemas/Condition"
} }
@@ -11802,12 +11860,12 @@
"type" : "string", "type" : "string",
"enum" : [ "balance" ] "enum" : [ "balance" ]
}, },
"WebhookSettingResponse" : { "WebhookSetting" : {
"type" : "object", "type" : "object",
"discriminator" : { "discriminator" : {
"propertyName" : "type", "propertyName" : "type",
"mapping" : { "mapping" : {
"balance" : "#/components/schemas/BalanceWebhookSettingsResponse" "balance" : "#/components/schemas/BalanceWebhookSetting"
} }
}, },
"properties" : { "properties" : {
@@ -11879,7 +11937,19 @@
} }
} }
}, },
"PatchableBalanceWebhookSettingsRequest" : { "WebhookSettings" : {
"type" : "object",
"properties" : {
"webhookSettings" : {
"type" : "array",
"description" : "The list of webhook settings.",
"items" : {
"$ref" : "#/components/schemas/WebhookSetting"
}
}
}
},
"BalanceWebhookSettingInfoUpdate" : {
"type" : "object", "type" : "object",
"properties" : { "properties" : {
"conditions" : { "conditions" : {
@@ -12072,7 +12142,7 @@
"description" : "Example response when retrieving an account holder", "description" : "Example response when retrieving an account holder",
"value" : { "value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM", "balancePlatform" : "YOUR_BALANCE_PLATFORM",
"description" : "Liable account holder used for international payments and payouts", "description" : "Account holder used for international payments and payouts",
"legalEntityId" : "LE322JV223222D5GG42KN6869", "legalEntityId" : "LE322JV223222D5GG42KN6869",
"reference" : "S.Eller-001", "reference" : "S.Eller-001",
"capabilities" : { "capabilities" : {
@@ -12515,7 +12585,7 @@
"summary" : "Request account holder capability", "summary" : "Request account holder capability",
"description" : "Example request for the `receivePayments` capability for an account holder", "description" : "Example request for the `receivePayments` capability for an account holder",
"value" : { "value" : {
"description" : "Liable account holder used for international payments and payouts", "description" : "Account holder used for international payments and payouts",
"reference" : "S.Eller-001", "reference" : "S.Eller-001",
"capabilities" : { "capabilities" : {
"receivePayments" : { "receivePayments" : {
@@ -12529,7 +12599,7 @@
"description" : "Example response for requesting the `receivePayments` capability for an account holder", "description" : "Example response for requesting the `receivePayments` capability for an account holder",
"value" : { "value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM", "balancePlatform" : "YOUR_BALANCE_PLATFORM",
"description" : "Liable account holder used for international payments and payouts", "description" : "Account holder used for international payments and payouts",
"legalEntityId" : "LE322JV223222F5GKQZZ9DS99", "legalEntityId" : "LE322JV223222F5GKQZZ9DS99",
"reference" : "S.Eller-001", "reference" : "S.Eller-001",
"capabilities" : { "capabilities" : {
@@ -12556,7 +12626,7 @@
"description" : "Example response for permanently deactivating an account holder", "description" : "Example response for permanently deactivating an account holder",
"value" : { "value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM", "balancePlatform" : "YOUR_BALANCE_PLATFORM",
"description" : "Liable account holder used for international payments and payouts", "description" : "Account holder used for international payments and payouts",
"legalEntityId" : "LE322JV223222F5GKQZZ9DS99", "legalEntityId" : "LE322JV223222F5GKQZZ9DS99",
"reference" : "S.Eller-001", "reference" : "S.Eller-001",
"id" : "AH3227C223222C5GKR23686TF", "id" : "AH3227C223222C5GKR23686TF",
@@ -12741,7 +12811,7 @@
"summary" : "Create an account holder", "summary" : "Create an account holder",
"description" : "Example request for creating an account holder", "description" : "Example request for creating an account holder",
"value" : { "value" : {
"description" : "Liable account holder used for international payments and payouts", "description" : "Account holder used for international payments and payouts",
"reference" : "S.Eller-001", "reference" : "S.Eller-001",
"legalEntityId" : "LE322JV223222D5GG42KN6869" "legalEntityId" : "LE322JV223222D5GG42KN6869"
} }
@@ -12751,7 +12821,7 @@
"description" : "Example response for creating an account holder", "description" : "Example response for creating an account holder",
"value" : { "value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM", "balancePlatform" : "YOUR_BALANCE_PLATFORM",
"description" : "Liable account holder used for international payments and payouts", "description" : "Account holder used for international payments and payouts",
"legalEntityId" : "LE322JV223222D5GG42KN6869", "legalEntityId" : "LE322JV223222D5GG42KN6869",
"reference" : "S.Eller-001", "reference" : "S.Eller-001",
"capabilities" : { "capabilities" : {

11
yaml/BalancePlatformConfigurationNotification-v1.yaml
View File

@@ -743,7 +743,8 @@ components:
type: array type: array
defaultCurrencyCode: defaultCurrencyCode:
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
of the balance account. of the balance account. This is the currency displayed on the Balance
Account overview page in your Customer Area.
The default value is **EUR**. The default value is **EUR**.
@@ -1395,6 +1396,14 @@ components:
description: Your reference for the payment instrument, maximum 150 characters. description: Your reference for the payment instrument, maximum 150 characters.
maxLength: 150 maxLength: 150
type: string type: string
replacedById:
description: The unique identifier of the payment instrument that replaced
this payment instrument.
type: string
replacementOfId:
description: The unique identifier of the payment instrument that is replaced
by this payment instrument.
type: string
status: status:
description: "The status of the payment instrument. If a status is not specified\ description: "The status of the payment instrument. If a status is not specified\
\ when creating a payment instrument, it is set to **Active** by default.\ \ when creating a payment instrument, it is set to **Active** by default.\

24
yaml/BalancePlatformConfigurationNotification-v2.yaml
View File

@@ -754,7 +754,8 @@ components:
type: array type: array
defaultCurrencyCode: defaultCurrencyCode:
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
of the balance account. of the balance account. This is the currency displayed on the Balance
Account overview page in your Customer Area.
The default value is **EUR**. The default value is **EUR**.
@@ -1455,6 +1456,14 @@ components:
description: Your reference for the payment instrument, maximum 150 characters. description: Your reference for the payment instrument, maximum 150 characters.
maxLength: 150 maxLength: 150
type: string type: string
replacedById:
description: The unique identifier of the payment instrument that replaced
this payment instrument.
type: string
replacementOfId:
description: The unique identifier of the payment instrument that is replaced
by this payment instrument.
type: string
status: status:
description: "The status of the payment instrument. If a status is not specified\ description: "The status of the payment instrument. If a status is not specified\
\ when creating a payment instrument, it is set to **active** by default.\ \ when creating a payment instrument, it is set to **active** by default.\
@@ -1743,9 +1752,16 @@ components:
x-addedInVersion: '2' x-addedInVersion: '2'
description: 'The list of priorities for the bank transfer. This sets the description: 'The list of priorities for the bank transfer. This sets the
speed at which the transfer is sent and the fees that you have to pay. speed at which the transfer is sent and the fees that you have to pay.
You can provide multiple priorities. Adyen will try to pay out using the You can provide multiple priorities, ordered by your preference. Adyen
priority you list first. If that''s not possible, it moves on to the next will try to pay out using the priorities in the given order. If the first
option in the order of your provided priorities. priority is not currently supported or enabled for your platform, the
system will try the next one, and so on.
The request will be accepted as long as **at least one** of the provided
priorities is valid (i.e., supported by Adyen and activated for your platform).
For example, if you provide `["wire","regular"]`, and `wire` is not supported
but `regular` is, the request will still be accepted and processed.
Possible values: Possible values:

224
yaml/BalancePlatformService-v2.yaml
View File

@@ -4432,8 +4432,9 @@ paths:
get: get:
tags: tags:
- Balances - Balances
summary: Get webhook settings summary: Get all balance webhook settings
description: Returns all settings configured for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated). description: Returns all balance webhook settings configured for triggering
[balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
operationId: get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings operationId: get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings
parameters: parameters:
- name: balancePlatformId - name: balancePlatformId
@@ -4458,36 +4459,35 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: array $ref: '#/components/schemas/WebhookSettings'
items:
$ref: '#/components/schemas/WebhookSettingResponse'
examples: examples:
get-webhook-settings-200: get-webhook-settings-200:
summary: Get all webhook settings summary: Get all webhook settings
description: Retrieve all settings of a webhook description: Retrieve all settings of a webhook
value: value:
- id: BWHS00000000000000000000000001 WebhookSettings:
type: balance - id: BWHS00000000000000000000000001
target: type: balance
type: balancePlatform target:
id: YOUR_BALANCE_PLATFORM type: balancePlatform
currency: USD id: YOUR_BALANCE_PLATFORM
status: active currency: USD
conditions: status: active
- balanceType: available conditions:
conditionType: lessThan - balanceType: available
value: 500000 conditionType: lessThan
- id: BWHS00000000000000000000000002 value: 500000
type: balance - id: BWHS00000000000000000000000002
target: type: balance
type: balanceAccount target:
id: BA00000000000000000LIABLE type: balanceAccount
currency: USD id: BA00000000000000000LIABLE
status: active currency: USD
conditions: status: active
- balanceType: available conditions:
conditionType: greaterThan - balanceType: available
value: 1000000 conditionType: greaterThan
value: 1000000
'400': '400':
description: Bad Request - a problem reading or understanding the request. description: Bad Request - a problem reading or understanding the request.
content: content:
@@ -4524,6 +4524,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/DefaultErrorResponseEntity' $ref: '#/components/schemas/DefaultErrorResponseEntity'
x-methodName: getAllWebhookSettings
x-sortIndex: 4 x-sortIndex: 4
post: post:
tags: tags:
@@ -4571,7 +4572,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/BalanceWebhookSettingsRequest' $ref: '#/components/schemas/BalanceWebhookSettingInfo'
examples: examples:
create-webhook-setting: create-webhook-setting:
summary: Create a webhook setting summary: Create a webhook setting
@@ -4594,7 +4595,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/WebhookSettingResponse' $ref: '#/components/schemas/WebhookSetting'
examples: examples:
create-webhook-setting: create-webhook-setting:
summary: Successfully created a webhook setting summary: Successfully created a webhook setting
@@ -4647,14 +4648,15 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/DefaultErrorResponseEntity' $ref: '#/components/schemas/DefaultErrorResponseEntity'
x-methodName: createWebhookSetting
x-sortIndex: 1 x-sortIndex: 1
/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}: /balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}:
get: get:
tags: tags:
- Balances - Balances
summary: Get a webhook setting summary: Get a balance webhook setting by id
description: Returns the details of a specific balance webhook setting configured description: Returns the details of a specific balance webhook setting configured
for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated). for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
operationId: get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId operationId: get-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId
parameters: parameters:
- name: balancePlatformId - name: balancePlatformId
@@ -4687,7 +4689,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/WebhookSettingResponse' $ref: '#/components/schemas/WebhookSetting'
examples: examples:
get-webhook-setting-by-id-200: get-webhook-setting-by-id-200:
summary: Get a webhook setting summary: Get a webhook setting
@@ -4740,13 +4742,14 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/DefaultErrorResponseEntity' $ref: '#/components/schemas/DefaultErrorResponseEntity'
x-methodName: getWebhookSetting
x-sortIndex: 3 x-sortIndex: 3
delete: delete:
tags: tags:
- Balances - Balances
summary: Delete a webhook setting summary: Delete a balance webhook setting by id
description: Deletes a setting that contains the conditions for triggering [balance description: Deletes a balance webhook setting that contains the conditions
webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated). for triggering [balance webhooks](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
operationId: delete-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId operationId: delete-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId
parameters: parameters:
- name: balancePlatformId - name: balancePlatformId
@@ -4774,8 +4777,9 @@ paths:
schema: schema:
type: string type: string
responses: responses:
'200': '204':
description: OK - the request has succeeded. description: No Content - the request has been successfully processed, but
there is no additional content.
content: content:
application/json: {} application/json: {}
'400': '400':
@@ -4814,13 +4818,14 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/DefaultErrorResponseEntity' $ref: '#/components/schemas/DefaultErrorResponseEntity'
x-methodName: deleteWebhookSetting
x-sortIndex: 5 x-sortIndex: 5
patch: patch:
tags: tags:
- Balances - Balances
summary: Update a webhook setting summary: Update a balance webhook setting by id
description: Updates the conditions the balance change needs to meet for Adyen description: Updates the conditions the balance change needs to meet for Adyen
to send a [balance webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated). to send a [balance webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
operationId: patch-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId operationId: patch-balancePlatforms-balancePlatformId-webhooks-webhookId-settings-settingId
parameters: parameters:
- name: balancePlatformId - name: balancePlatformId
@@ -4851,7 +4856,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/PatchableBalanceWebhookSettingsRequest' $ref: '#/components/schemas/BalanceWebhookSettingInfoUpdate'
examples: examples:
update-webhook-setting: update-webhook-setting:
summary: Update a webhook setting summary: Update a webhook setting
@@ -4883,7 +4888,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/WebhookSettingResponse' $ref: '#/components/schemas/WebhookSetting'
examples: examples:
update-webhook-setting: update-webhook-setting:
summary: Successfully updated a webhook setting summary: Successfully updated a webhook setting
@@ -4957,6 +4962,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/DefaultErrorResponseEntity' $ref: '#/components/schemas/DefaultErrorResponseEntity'
x-methodName: updateWebhookSetting
x-sortIndex: 2 x-sortIndex: 2
components: components:
schemas: schemas:
@@ -5753,7 +5759,8 @@ components:
defaultCurrencyCode: defaultCurrencyCode:
type: string type: string
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
of the balance account. of the balance account. This is the currency displayed on the Balance
Account overview page in your Customer Area.
The default value is **EUR**. The default value is **EUR**.
@@ -5820,7 +5827,8 @@ components:
defaultCurrencyCode: defaultCurrencyCode:
type: string type: string
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
of the balance account. of the balance account. This is the currency displayed on the Balance
Account overview page in your Customer Area.
The default value is **EUR**. The default value is **EUR**.
@@ -5887,7 +5895,8 @@ components:
defaultCurrencyCode: defaultCurrencyCode:
type: string type: string
description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)
of the balance account. of the balance account. This is the currency displayed on the Balance
Account overview page in your Customer Area.
The default value is **EUR**. The default value is **EUR**.
@@ -6898,9 +6907,16 @@ components:
type: array type: array
description: 'The list of priorities for the bank transfer. This sets the description: 'The list of priorities for the bank transfer. This sets the
speed at which the transfer is sent and the fees that you have to pay. speed at which the transfer is sent and the fees that you have to pay.
You can provide multiple priorities. Adyen will try to pay out using the You can provide multiple priorities, ordered by your preference. Adyen
priority you list first. If that''s not possible, it moves on to the next will try to pay out using the priorities in the given order. If the first
option in the order of your provided priorities. priority is not currently supported or enabled for your platform, the
system will try the next one, and so on.
The request will be accepted as long as **at least one** of the provided
priorities is valid (i.e., supported by Adyen and activated for your platform).
For example, if you provide `["wire","regular"]`, and `wire` is not supported
but `regular` is, the request will still be accepted and processed.
Possible values: Possible values:
@@ -7954,6 +7970,14 @@ components:
type: string type: string
description: Your reference for the payment instrument, maximum 150 characters. description: Your reference for the payment instrument, maximum 150 characters.
maxLength: 150 maxLength: 150
replacedById:
type: string
description: The unique identifier of the payment instrument that replaced
this payment instrument.
replacementOfId:
type: string
description: The unique identifier of the payment instrument that is replaced
by this payment instrument.
status: status:
type: string type: string
description: "The status of the payment instrument. If a status is not specified\ description: "The status of the payment instrument. If a status is not specified\
@@ -8821,9 +8845,16 @@ components:
type: array type: array
description: 'The list of priorities for the bank transfer. This sets the description: 'The list of priorities for the bank transfer. This sets the
speed at which the transfer is sent and the fees that you have to pay. speed at which the transfer is sent and the fees that you have to pay.
You can provide multiple priorities. Adyen will try to pay out using the You can provide multiple priorities, ordered by your preference. Adyen
priority you list first. If that''s not possible, it moves on to the next will try to pay out using the priorities in the given order. If the first
option in the order of your provided priorities. priority is not currently supported or enabled for your platform, the
system will try the next one, and so on.
The request will be accepted as long as **at least one** of the provided
priorities is valid (i.e., supported by Adyen and activated for your platform).
For example, if you provide `["wire","regular"]`, and `wire` is not supported
but `regular` is, the request will still be accepted and processed.
Possible values: Possible values:
@@ -9683,6 +9714,20 @@ components:
description: 'The total amount and the operation. description: 'The total amount and the operation.
Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**,
**greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
walletProviderAccountScore:
$ref: '#/components/schemas/WalletProviderAccountScoreRestriction'
description: 'Checks the wallet account score.
Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**,
**greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
walletProviderDeviceScore:
$ref: '#/components/schemas/WalletProviderDeviceScore'
description: 'Wallet Provider Device Score and the operation.
Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**,
**greaterThan**, **lessThanOrEqualTo**, **lessThan**.' **greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
TransactionRulesResponse: TransactionRulesResponse:
@@ -10007,6 +10052,14 @@ components:
type: string type: string
description: Your reference for the payment instrument, maximum 150 characters. description: Your reference for the payment instrument, maximum 150 characters.
maxLength: 150 maxLength: 150
replacedById:
type: string
description: The unique identifier of the payment instrument that replaced
this payment instrument.
replacementOfId:
type: string
description: The unique identifier of the payment instrument that is replaced
by this payment instrument.
status: status:
type: string type: string
description: "The status of the payment instrument. If a status is not specified\ description: "The status of the payment instrument. If a status is not specified\
@@ -10113,9 +10166,16 @@ components:
type: array type: array
description: 'The list of priorities for the bank transfer. This sets the description: 'The list of priorities for the bank transfer. This sets the
speed at which the transfer is sent and the fees that you have to pay. speed at which the transfer is sent and the fees that you have to pay.
You can provide multiple priorities. Adyen will try to pay out using the You can provide multiple priorities, ordered by your preference. Adyen
priority you list first. If that''s not possible, it moves on to the next will try to pay out using the priorities in the given order. If the first
option in the order of your provided priorities. priority is not currently supported or enabled for your platform, the
system will try the next one, and so on.
The request will be accepted as long as **at least one** of the provided
priorities is valid (i.e., supported by Adyen and activated for your platform).
For example, if you provide `["wire","regular"]`, and `wire` is not supported
but `regular` is, the request will still be accepted and processed.
Possible values: Possible values:
@@ -10506,7 +10566,31 @@ components:
error. error.
items: items:
$ref: '#/components/schemas/RemediatingAction' $ref: '#/components/schemas/RemediatingAction'
BalanceWebhookSettingsRequest: WalletProviderAccountScoreRestriction:
type: object
additionalProperties: false
properties:
operation:
type: string
description: Defines how the condition must be evaluated.
value:
type: integer
format: int32
required:
- operation
WalletProviderDeviceScore:
type: object
additionalProperties: false
properties:
operation:
type: string
description: Defines how the condition must be evaluated.
value:
type: integer
format: int32
required:
- operation
BalanceWebhookSettingInfo:
type: object type: object
properties: properties:
conditions: conditions:
@@ -10648,16 +10732,16 @@ components:
required: required:
- id - id
- type - type
BalanceWebhookSettingsResponse: BalanceWebhookSetting:
type: object type: object
allOf: allOf:
- $ref: '#/components/schemas/WebhookSettingResponse' - $ref: '#/components/schemas/WebhookSetting'
- type: object - type: object
properties: properties:
conditions: conditions:
type: array type: array
description: The list of settings and criteria for triggering the [balance description: The list of settings and criteria for triggering the [balance
webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balancePlatform.balanceAccount.balance.updated). webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).
items: items:
$ref: '#/components/schemas/Condition' $ref: '#/components/schemas/Condition'
required: required:
@@ -10670,12 +10754,12 @@ components:
type: string type: string
enum: enum:
- balance - balance
WebhookSettingResponse: WebhookSetting:
type: object type: object
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
balance: '#/components/schemas/BalanceWebhookSettingsResponse' balance: '#/components/schemas/BalanceWebhookSetting'
properties: properties:
currency: currency:
type: string type: string
@@ -10742,7 +10826,15 @@ components:
type: string type: string
description: A URI that identifies the validation error type. It points description: A URI that identifies the validation error type. It points
to human-readable documentation for the problem type. to human-readable documentation for the problem type.
PatchableBalanceWebhookSettingsRequest: WebhookSettings:
type: object
properties:
webhookSettings:
type: array
description: The list of webhook settings.
items:
$ref: '#/components/schemas/WebhookSetting'
BalanceWebhookSettingInfoUpdate:
type: object type: object
properties: properties:
conditions: conditions:
@@ -10936,7 +11028,7 @@ components:
description: Example response when retrieving an account holder description: Example response when retrieving an account holder
value: value:
balancePlatform: YOUR_BALANCE_PLATFORM balancePlatform: YOUR_BALANCE_PLATFORM
description: Liable account holder used for international payments and payouts description: Account holder used for international payments and payouts
legalEntityId: LE322JV223222D5GG42KN6869 legalEntityId: LE322JV223222D5GG42KN6869
reference: S.Eller-001 reference: S.Eller-001
capabilities: capabilities:
@@ -11294,7 +11386,7 @@ components:
description: Example request for the `receivePayments` capability for an account description: Example request for the `receivePayments` capability for an account
holder holder
value: value:
description: Liable account holder used for international payments and payouts description: Account holder used for international payments and payouts
reference: S.Eller-001 reference: S.Eller-001
capabilities: capabilities:
receivePayments: receivePayments:
@@ -11305,7 +11397,7 @@ components:
for an account holder for an account holder
value: value:
balancePlatform: YOUR_BALANCE_PLATFORM balancePlatform: YOUR_BALANCE_PLATFORM
description: Liable account holder used for international payments and payouts description: Account holder used for international payments and payouts
legalEntityId: LE322JV223222F5GKQZZ9DS99 legalEntityId: LE322JV223222F5GKQZZ9DS99
reference: S.Eller-001 reference: S.Eller-001
capabilities: capabilities:
@@ -11326,7 +11418,7 @@ components:
description: Example response for permanently deactivating an account holder description: Example response for permanently deactivating an account holder
value: value:
balancePlatform: YOUR_BALANCE_PLATFORM balancePlatform: YOUR_BALANCE_PLATFORM
description: Liable account holder used for international payments and payouts description: Account holder used for international payments and payouts
legalEntityId: LE322JV223222F5GKQZZ9DS99 legalEntityId: LE322JV223222F5GKQZZ9DS99
reference: S.Eller-001 reference: S.Eller-001
id: AH3227C223222C5GKR23686TF id: AH3227C223222C5GKR23686TF
@@ -11474,7 +11566,7 @@ components:
summary: Create an account holder summary: Create an account holder
description: Example request for creating an account holder description: Example request for creating an account holder
value: value:
description: Liable account holder used for international payments and payouts description: Account holder used for international payments and payouts
reference: S.Eller-001 reference: S.Eller-001
legalEntityId: LE322JV223222D5GG42KN6869 legalEntityId: LE322JV223222D5GG42KN6869
post-accountHolders-createAccountHolder-200: post-accountHolders-createAccountHolder-200:
@@ -11482,7 +11574,7 @@ components:
description: Example response for creating an account holder description: Example response for creating an account holder
value: value:
balancePlatform: YOUR_BALANCE_PLATFORM balancePlatform: YOUR_BALANCE_PLATFORM
description: Liable account holder used for international payments and payouts description: Account holder used for international payments and payouts
legalEntityId: LE322JV223222D5GG42KN6869 legalEntityId: LE322JV223222D5GG42KN6869
reference: S.Eller-001 reference: S.Eller-001
capabilities: capabilities: