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

spec release

Browse Source
This commit is contained in:
Adyen Automation
2024-06-05 16:12:10 +02:00
parent 85b8ffc50a
commit ee0f2d96c4
16 changed files with 863 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
json/BalancePlatformAcsNotification-v1.json
View File

@@ -334,7 +334,7 @@
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"description" : "Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"type" : "string"
}
},

4
json/BalancePlatformPaymentNotification-v1.json
View File

@@ -392,7 +392,7 @@
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"description" : "Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"type" : "string"
}
},
@@ -949,6 +949,8 @@
"PaymentFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"TopUp",
"VAT"
],

7
json/BalancePlatformTransferNotification-v3.json
View File

@@ -311,7 +311,7 @@
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"description" : "Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"type" : "string"
}
},
@@ -1370,6 +1370,8 @@
"PaymentFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"TopUp",
"VAT"
],
@@ -1446,8 +1448,7 @@
},
"referenceForBeneficiary" : {
"x-addedInVersion" : "2",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"maxLength" : 80,
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"type" : "string"
},
"relayedAuthorisationData" : {

10
json/BalancePlatformTransferNotification-v4.json
View File

@@ -311,7 +311,7 @@
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"description" : "Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"type" : "string"
}
},
@@ -1174,6 +1174,8 @@
"PaymentFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"TopUp",
"VAT"
],
@@ -1534,8 +1536,7 @@
},
"referenceForBeneficiary" : {
"x-addedInVersion" : "2",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"maxLength" : 80,
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"type" : "string"
},
"sequenceNumber" : {
@@ -1712,9 +1713,6 @@
},
"estimatedArrivalTime" : {
"x-addedInVersion" : "3",
"deprecated" : true,
"x-deprecatedInVersion" : "4",
"x-deprecatedMessage" : "This property will be removed in v5 and replaced by the [trackingData.estimatedArrivalTime](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.updated#request-data-tracking-EstimationTrackingData).",
"description" : "The estimated time the beneficiary should have access to the funds.",
"format" : "date-time",
"type" : "string"

100
json/TransferService-v1.json
View File

@@ -365,7 +365,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -375,7 +375,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -385,7 +385,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -707,6 +707,36 @@
],
"type" : "object"
},
"RoutingDetails" : {
"additionalProperties" : false,
"properties" : {
"detail" : {
"description" : "A human-readable explanation specific to this occurrence of the problem.",
"type" : "string"
},
"errorCode" : {
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"priority" : {
"description" : "The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**.\n\nPossible values:\n\n* **regular**: For normal, low-value transactions.\n\n* **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.\n\n* **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: High-value transfer to a recipient in a different country.\n\n* **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN).",
"enum" : [
"crossBorder",
"fast",
"instant",
"internal",
"regular",
"wire"
],
"type" : "string"
},
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
}
},
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
@@ -942,7 +972,7 @@
},
"reference" : {
"x-addedInVersion" : "1",
"description" : "Your unique reference for the transfer. You can use alphanumeric characters and hyphens. Maximum length: 80 characters.",
"description" : "Your unique reference for the transfer. You can use alphanumeric characters and hyphens. ",
"maxLength" : 80,
"type" : "string"
},
@@ -984,7 +1014,7 @@
},
"reference" : {
"x-addedInVersion" : "1",
"description" : "Your unique reference for the transfer. You can use alphanumeric characters and hyphens. Maximum length: 80 characters.",
"description" : "Your unique reference for the transfer. You can use alphanumeric characters and hyphens. ",
"maxLength" : 80,
"type" : "string"
},
@@ -1012,6 +1042,66 @@
"resultCode"
],
"type" : "object"
},
"TransferServiceRestServiceError" : {
"additionalProperties" : false,
"properties" : {
"detail" : {
"description" : "A human-readable explanation specific to this occurrence of the problem.",
"type" : "string"
},
"errorCode" : {
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"instance" : {
"description" : "A unique URI that identifies the specific occurrence of the problem.",
"type" : "string"
},
"invalidFields" : {
"description" : "Detailed explanation of each validation error, when applicable.",
"items" : {
"$ref" : "#/components/schemas/InvalidField"
},
"type" : "array"
},
"requestId" : {
"description" : "A unique reference for the request, essentially the same as `pspReference`.",
"type" : "string"
},
"response" : {
"description" : "JSON response payload.",
"$ref" : "#/components/schemas/JSONObject"
},
"routingDetails" : {
"description" : "Detailed explanation of each attempt to route the transfer with the priorities from the request.",
"items" : {
"$ref" : "#/components/schemas/RoutingDetails"
},
"type" : "array"
},
"status" : {
"description" : "The HTTP status code.",
"format" : "int32",
"type" : "integer"
},
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
},
"type" : {
"description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.",
"type" : "string"
}
},
"required" : [
"type",
"errorCode",
"title",
"detail",
"status"
],
"type" : "object"
}
},
"securitySchemes" : {

100
json/TransferService-v2.json
View File

@@ -381,7 +381,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -391,7 +391,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -401,7 +401,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -732,6 +732,36 @@
],
"type" : "object"
},
"RoutingDetails" : {
"additionalProperties" : false,
"properties" : {
"detail" : {
"description" : "A human-readable explanation specific to this occurrence of the problem.",
"type" : "string"
},
"errorCode" : {
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"priority" : {
"description" : "The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**.\n\nPossible values:\n\n* **regular**: For normal, low-value transactions.\n\n* **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.\n\n* **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: High-value transfer to a recipient in a different country.\n\n* **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN).",
"enum" : [
"crossBorder",
"fast",
"instant",
"internal",
"regular",
"wire"
],
"type" : "string"
},
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
}
},
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
@@ -1024,7 +1054,7 @@
},
"referenceForBeneficiary" : {
"x-addedInVersion" : "2",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80 characters.",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**.",
"maxLength" : 80,
"type" : "string"
},
@@ -1147,7 +1177,7 @@
},
"referenceForBeneficiary" : {
"x-addedInVersion" : "2",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80 characters.",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**.",
"maxLength" : 80,
"type" : "string"
}
@@ -1157,6 +1187,66 @@
"counterparty"
],
"type" : "object"
},
"TransferServiceRestServiceError" : {
"additionalProperties" : false,
"properties" : {
"detail" : {
"description" : "A human-readable explanation specific to this occurrence of the problem.",
"type" : "string"
},
"errorCode" : {
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"instance" : {
"description" : "A unique URI that identifies the specific occurrence of the problem.",
"type" : "string"
},
"invalidFields" : {
"description" : "Detailed explanation of each validation error, when applicable.",
"items" : {
"$ref" : "#/components/schemas/InvalidField"
},
"type" : "array"
},
"requestId" : {
"description" : "A unique reference for the request, essentially the same as `pspReference`.",
"type" : "string"
},
"response" : {
"description" : "JSON response payload.",
"$ref" : "#/components/schemas/JSONObject"
},
"routingDetails" : {
"description" : "Detailed explanation of each attempt to route the transfer with the priorities from the request.",
"items" : {
"$ref" : "#/components/schemas/RoutingDetails"
},
"type" : "array"
},
"status" : {
"description" : "The HTTP status code.",
"format" : "int32",
"type" : "integer"
},
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
},
"type" : {
"description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.",
"type" : "string"
}
},
"required" : [
"type",
"errorCode",
"title",
"detail",
"status"
],
"type" : "object"
}
},
"securitySchemes" : {

108
json/TransferService-v3.json
View File

@@ -729,7 +729,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -739,7 +739,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -749,7 +749,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -818,7 +818,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -828,7 +828,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -838,7 +838,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -848,7 +848,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -1892,6 +1892,36 @@
},
"type" : "object"
},
"RoutingDetails" : {
"additionalProperties" : false,
"properties" : {
"detail" : {
"description" : "A human-readable explanation specific to this occurrence of the problem.",
"type" : "string"
},
"errorCode" : {
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"priority" : {
"description" : "The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**.\n\nPossible values:\n\n* **regular**: For normal, low-value transactions.\n\n* **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.\n\n* **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: High-value transfer to a recipient in a different country.\n\n* **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN).",
"enum" : [
"crossBorder",
"fast",
"instant",
"internal",
"regular",
"wire"
],
"type" : "string"
},
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
}
},
"type" : "object"
},
"SELocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
@@ -2313,8 +2343,7 @@
},
"referenceForBeneficiary" : {
"x-addedInVersion" : "2",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"maxLength" : 80,
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"type" : "string"
},
"status" : {
@@ -2503,7 +2532,6 @@
"referenceForBeneficiary" : {
"x-addedInVersion" : "2",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"maxLength" : 80,
"type" : "string"
},
"ultimateParty" : {
@@ -2519,6 +2547,66 @@
],
"type" : "object"
},
"TransferServiceRestServiceError" : {
"additionalProperties" : false,
"properties" : {
"detail" : {
"description" : "A human-readable explanation specific to this occurrence of the problem.",
"type" : "string"
},
"errorCode" : {
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"instance" : {
"description" : "A unique URI that identifies the specific occurrence of the problem.",
"type" : "string"
},
"invalidFields" : {
"description" : "Detailed explanation of each validation error, when applicable.",
"items" : {
"$ref" : "#/components/schemas/InvalidField"
},
"type" : "array"
},
"requestId" : {
"description" : "A unique reference for the request, essentially the same as `pspReference`.",
"type" : "string"
},
"response" : {
"description" : "JSON response payload.",
"$ref" : "#/components/schemas/JSONObject"
},
"routingDetails" : {
"description" : "Detailed explanation of each attempt to route the transfer with the priorities from the request.",
"items" : {
"$ref" : "#/components/schemas/RoutingDetails"
},
"type" : "array"
},
"status" : {
"description" : "The HTTP status code.",
"format" : "int32",
"type" : "integer"
},
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
},
"type" : {
"description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.",
"type" : "string"
}
},
"required" : [
"type",
"errorCode",
"title",
"detail",
"status"
],
"type" : "object"
},
"UKLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {

132
json/TransferService-v4.json
View File

@@ -800,7 +800,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -810,7 +810,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -820,7 +820,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -830,7 +830,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -946,7 +946,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -956,7 +956,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -966,7 +966,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -1031,7 +1031,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -1041,7 +1041,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -1051,7 +1051,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -1061,7 +1061,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -1140,7 +1140,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -1150,7 +1150,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -1160,7 +1160,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -1170,7 +1170,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
@@ -2484,6 +2484,8 @@
"PaymentFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"TopUp",
"VAT"
],
@@ -2680,6 +2682,36 @@
},
"type" : "object"
},
"RoutingDetails" : {
"additionalProperties" : false,
"properties" : {
"detail" : {
"description" : "A human-readable explanation specific to this occurrence of the problem.",
"type" : "string"
},
"errorCode" : {
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"priority" : {
"description" : "The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**.\n\nPossible values:\n\n* **regular**: For normal, low-value transactions.\n\n* **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.\n\n* **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: High-value transfer to a recipient in a different country.\n\n* **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN).",
"enum" : [
"crossBorder",
"fast",
"instant",
"internal",
"regular",
"wire"
],
"type" : "string"
},
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
}
},
"type" : "object"
},
"SELocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
@@ -3087,8 +3119,7 @@
},
"referenceForBeneficiary" : {
"x-addedInVersion" : "2",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"maxLength" : 80,
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"type" : "string"
},
"status" : {
@@ -3349,8 +3380,7 @@
},
"referenceForBeneficiary" : {
"x-addedInVersion" : "2",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"maxLength" : 80,
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"type" : "string"
},
"sequenceNumber" : {
@@ -3527,9 +3557,6 @@
},
"estimatedArrivalTime" : {
"x-addedInVersion" : "3",
"deprecated" : true,
"x-deprecatedInVersion" : "4",
"x-deprecatedMessage" : "This property will be removed in v5 and replaced by the [trackingData.estimatedArrivalTime](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.updated#request-data-tracking-EstimationTrackingData).",
"description" : "The estimated time the beneficiary should have access to the funds.",
"format" : "date-time",
"type" : "string"
@@ -3763,7 +3790,6 @@
"referenceForBeneficiary" : {
"x-addedInVersion" : "2",
"description" : " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others.",
"maxLength" : 80,
"type" : "string"
},
"ultimateParty" : {
@@ -3849,6 +3875,66 @@
},
"type" : "object"
},
"TransferServiceRestServiceError" : {
"additionalProperties" : false,
"properties" : {
"detail" : {
"description" : "A human-readable explanation specific to this occurrence of the problem.",
"type" : "string"
},
"errorCode" : {
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"instance" : {
"description" : "A unique URI that identifies the specific occurrence of the problem.",
"type" : "string"
},
"invalidFields" : {
"description" : "Detailed explanation of each validation error, when applicable.",
"items" : {
"$ref" : "#/components/schemas/InvalidField"
},
"type" : "array"
},
"requestId" : {
"description" : "A unique reference for the request, essentially the same as `pspReference`.",
"type" : "string"
},
"response" : {
"description" : "JSON response payload.",
"$ref" : "#/components/schemas/JSONObject"
},
"routingDetails" : {
"description" : "Detailed explanation of each attempt to route the transfer with the priorities from the request.",
"items" : {
"$ref" : "#/components/schemas/RoutingDetails"
},
"type" : "array"
},
"status" : {
"description" : "The HTTP status code.",
"format" : "int32",
"type" : "integer"
},
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
},
"type" : {
"description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.",
"type" : "string"
}
},
"required" : [
"type",
"errorCode",
"title",
"detail",
"status"
],
"type" : "object"
},
"TransferView" : {
"additionalProperties" : false,
"properties" : {

3
yaml/BalancePlatformAcsNotification-v1.yaml
View File

@@ -357,8 +357,7 @@ components:
additionalProperties: false
properties:
notificationResponse:
description: Respond with **HTTP 200 OK** and `[accepted]` in the response
body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
description: Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
type: string
type: object
ChallengeInfo:

5
yaml/BalancePlatformPaymentNotification-v1.yaml
View File

@@ -322,8 +322,7 @@ components:
additionalProperties: false
properties:
notificationResponse:
description: Respond with **HTTP 200 OK** and `[accepted]` in the response
body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
description: Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
type: string
type: object
BankAccountInfo:
@@ -856,6 +855,8 @@ components:
- PaymentFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- TopUp
- VAT
type: string

10
yaml/BalancePlatformTransferNotification-v3.yaml
View File

@@ -265,8 +265,7 @@ components:
additionalProperties: false
properties:
notificationResponse:
description: Respond with **HTTP 200 OK** and `[accepted]` in the response
body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
description: Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
type: string
type: object
BankAccountV3:
@@ -1182,6 +1181,8 @@ components:
- PaymentFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- TopUp
- VAT
type: string
@@ -1283,10 +1284,9 @@ components:
description: " A reference that is sent to the recipient. This reference\
\ is also sent in all webhooks related to the transfer, so you can use\
\ it to track statuses for both the source and recipient of funds.\n\n\
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
\ Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends\
\ on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**:\
\ 35 characters when transferring to an IBAN, 15 characters for others."
maxLength: 80
type: string
relayedAuthorisationData:
x-addedInVersion: '3'

14
yaml/BalancePlatformTransferNotification-v4.yaml
View File

@@ -265,8 +265,7 @@ components:
additionalProperties: false
properties:
notificationResponse:
description: Respond with **HTTP 200 OK** and `[accepted]` in the response
body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
description: Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
type: string
type: object
BankAccountV3:
@@ -1007,6 +1006,8 @@ components:
- PaymentFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- TopUp
- VAT
type: string
@@ -1317,10 +1318,9 @@ components:
description: " A reference that is sent to the recipient. This reference\
\ is also sent in all webhooks related to the transfer, so you can use\
\ it to track statuses for both the source and recipient of funds.\n\n\
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
\ Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends\
\ on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**:\
\ 35 characters when transferring to an IBAN, 15 characters for others."
maxLength: 80
type: string
sequenceNumber:
x-addedInVersion: '3'
@@ -1482,10 +1482,6 @@ components:
type: string
estimatedArrivalTime:
x-addedInVersion: '3'
deprecated: true
x-deprecatedInVersion: '4'
x-deprecatedMessage: This property will be removed in v5 and replaced by
the [trackingData.estimatedArrivalTime](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.updated#request-data-tracking-EstimationTrackingData).
description: The estimated time the beneficiary should have access to the
funds.
format: date-time

110
yaml/TransferService-v1.yaml
View File

@@ -310,19 +310,19 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Internal Server Error - the server could not process the request.
components:
schemas:
@@ -573,6 +573,56 @@ components:
- detail
- status
type: object
RoutingDetails:
additionalProperties: false
properties:
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
errorCode:
description: A code that identifies the problem type.
type: string
priority:
description: 'The priority for the bank transfer. This sets the speed at
which the transfer is sent and the fees that you have to pay. Required
for transfers with `category` **bank**.
Possible values:
* **regular**: For normal, low-value transactions.
* **fast**: Faster way to transfer funds but has higher fees. Recommended
for high-priority, low-value transactions.
* **wire**: Fastest way to transfer funds but has the highest fees. Recommended
for high-priority, high-value transactions.
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).
* **crossBorder**: High-value transfer to a recipient in a different country.
* **internal**: Transfer to an Adyen-issued business bank account (by
bank account number/IBAN).'
enum:
- crossBorder
- fast
- instant
- internal
- regular
- wire
type: string
title:
description: A short, human-readable summary of the problem type.
type: string
type: object
ServiceError:
additionalProperties: false
properties:
@@ -796,7 +846,7 @@ components:
reference:
x-addedInVersion: '1'
description: 'Your unique reference for the transfer. You can use alphanumeric
characters and hyphens. Maximum length: 80 characters.'
characters and hyphens. '
maxLength: 80
type: string
source:
@@ -835,7 +885,7 @@ components:
reference:
x-addedInVersion: '1'
description: 'Your unique reference for the transfer. You can use alphanumeric
characters and hyphens. Maximum length: 80 characters.'
characters and hyphens. '
maxLength: 80
type: string
refusalReason:
@@ -859,6 +909,56 @@ components:
- id
- resultCode
type: object
TransferServiceRestServiceError:
additionalProperties: false
properties:
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
errorCode:
description: A code that identifies the problem type.
type: string
instance:
description: A unique URI that identifies the specific occurrence of the
problem.
type: string
invalidFields:
description: Detailed explanation of each validation error, when applicable.
items:
$ref: '#/components/schemas/InvalidField'
type: array
requestId:
description: A unique reference for the request, essentially the same as
`pspReference`.
type: string
response:
description: JSON response payload.
$ref: '#/components/schemas/JSONObject'
routingDetails:
description: Detailed explanation of each attempt to route the transfer
with the priorities from the request.
items:
$ref: '#/components/schemas/RoutingDetails'
type: array
status:
description: The HTTP status code.
format: int32
type: integer
title:
description: A short, human-readable summary of the problem type.
type: string
type:
description: A URI that identifies the problem type, pointing to human-readable
documentation on this problem type.
type: string
required:
- type
- errorCode
- title
- detail
- status
type: object
securitySchemes:
ApiKeyAuth:
in: header

112
yaml/TransferService-v2.yaml
View File

@@ -322,19 +322,19 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Internal Server Error - the server could not process the request.
components:
schemas:
@@ -619,6 +619,56 @@ components:
- detail
- status
type: object
RoutingDetails:
additionalProperties: false
properties:
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
errorCode:
description: A code that identifies the problem type.
type: string
priority:
description: 'The priority for the bank transfer. This sets the speed at
which the transfer is sent and the fees that you have to pay. Required
for transfers with `category` **bank**.
Possible values:
* **regular**: For normal, low-value transactions.
* **fast**: Faster way to transfer funds but has higher fees. Recommended
for high-priority, low-value transactions.
* **wire**: Fastest way to transfer funds but has the highest fees. Recommended
for high-priority, high-value transactions.
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).
* **crossBorder**: High-value transfer to a recipient in a different country.
* **internal**: Transfer to an Adyen-issued business bank account (by
bank account number/IBAN).'
enum:
- crossBorder
- fast
- instant
- internal
- regular
- wire
type: string
title:
description: A short, human-readable summary of the problem type.
type: string
type: object
ServiceError:
additionalProperties: false
properties:
@@ -905,8 +955,7 @@ components:
description: " A reference that is sent to the recipient. This reference\
\ is also sent in all webhooks related to the transfer, so you can use\
\ it to track statuses for both the source and recipient of funds.\n\n\
\ Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80\
\ characters."
\ Supported characters: **a-z**, **A-Z**, **0-9**."
maxLength: 80
type: string
status:
@@ -1034,14 +1083,63 @@ components:
description: " A reference that is sent to the recipient. This reference\
\ is also sent in all webhooks related to the transfer, so you can use\
\ it to track statuses for both the source and recipient of funds.\n\n\
\ Supported characters: **a-z**, **A-Z**, **0-9**. Maximum length: 80\
\ characters."
\ Supported characters: **a-z**, **A-Z**, **0-9**."
maxLength: 80
type: string
required:
- amount
- counterparty
type: object
TransferServiceRestServiceError:
additionalProperties: false
properties:
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
errorCode:
description: A code that identifies the problem type.
type: string
instance:
description: A unique URI that identifies the specific occurrence of the
problem.
type: string
invalidFields:
description: Detailed explanation of each validation error, when applicable.
items:
$ref: '#/components/schemas/InvalidField'
type: array
requestId:
description: A unique reference for the request, essentially the same as
`pspReference`.
type: string
response:
description: JSON response payload.
$ref: '#/components/schemas/JSONObject'
routingDetails:
description: Detailed explanation of each attempt to route the transfer
with the priorities from the request.
items:
$ref: '#/components/schemas/RoutingDetails'
type: array
status:
description: The HTTP status code.
format: int32
type: integer
title:
description: A short, human-readable summary of the problem type.
type: string
type:
description: A URI that identifies the problem type, pointing to human-readable
documentation on this problem type.
type: string
required:
- type
- errorCode
- title
- detail
- status
type: object
securitySchemes:
ApiKeyAuth:
in: header

120
yaml/TransferService-v3.yaml
View File

@@ -525,19 +525,19 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Internal Server Error - the server could not process the request.
/transfers/{transferId}/returns:
post:
@@ -577,25 +577,25 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Internal Server Error - the server could not process the request.
components:
schemas:
@@ -1444,6 +1444,56 @@ components:
description: The unique identifier of the original transfer.
type: string
type: object
RoutingDetails:
additionalProperties: false
properties:
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
errorCode:
description: A code that identifies the problem type.
type: string
priority:
description: 'The priority for the bank transfer. This sets the speed at
which the transfer is sent and the fees that you have to pay. Required
for transfers with `category` **bank**.
Possible values:
* **regular**: For normal, low-value transactions.
* **fast**: Faster way to transfer funds but has higher fees. Recommended
for high-priority, low-value transactions.
* **wire**: Fastest way to transfer funds but has the highest fees. Recommended
for high-priority, high-value transactions.
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).
* **crossBorder**: High-value transfer to a recipient in a different country.
* **internal**: Transfer to an Adyen-issued business bank account (by
bank account number/IBAN).'
enum:
- crossBorder
- fast
- instant
- internal
- regular
- wire
type: string
title:
description: A short, human-readable summary of the problem type.
type: string
type: object
SELocalAccountIdentification:
additionalProperties: false
properties:
@@ -1872,10 +1922,9 @@ components:
description: " A reference that is sent to the recipient. This reference\
\ is also sent in all webhooks related to the transfer, so you can use\
\ it to track statuses for both the source and recipient of funds.\n\n\
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
\ Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends\
\ on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**:\
\ 35 characters when transferring to an IBAN, 15 characters for others."
maxLength: 80
type: string
status:
x-addedInVersion: '2'
@@ -2096,7 +2145,6 @@ components:
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
\ 35 characters when transferring to an IBAN, 15 characters for others."
maxLength: 80
type: string
ultimateParty:
x-addedInVersion: '3'
@@ -2108,6 +2156,56 @@ components:
- amount
- counterparty
type: object
TransferServiceRestServiceError:
additionalProperties: false
properties:
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
errorCode:
description: A code that identifies the problem type.
type: string
instance:
description: A unique URI that identifies the specific occurrence of the
problem.
type: string
invalidFields:
description: Detailed explanation of each validation error, when applicable.
items:
$ref: '#/components/schemas/InvalidField'
type: array
requestId:
description: A unique reference for the request, essentially the same as
`pspReference`.
type: string
response:
description: JSON response payload.
$ref: '#/components/schemas/JSONObject'
routingDetails:
description: Detailed explanation of each attempt to route the transfer
with the priorities from the request.
items:
$ref: '#/components/schemas/RoutingDetails'
type: array
status:
description: The HTTP status code.
format: int32
type: integer
title:
description: A short, human-readable summary of the problem type.
type: string
type:
description: A URI that identifies the problem type, pointing to human-readable
documentation on this problem type.
type: string
required:
- type
- errorCode
- title
- detail
- status
type: object
UKLocalAccountIdentification:
additionalProperties: false
properties:

147
yaml/TransferService-v4.yaml
View File

@@ -608,25 +608,25 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Internal Server Error - the server could not process the request.
post:
tags:
@@ -708,19 +708,19 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Internal Server Error - the server could not process the request.
/transfers/{id}:
get:
@@ -757,25 +757,25 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Internal Server Error - the server could not process the request.
/transfers/{transferId}/returns:
post:
@@ -821,25 +821,25 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RestServiceError'
$ref: '#/components/schemas/TransferServiceRestServiceError'
description: Internal Server Error - the server could not process the request.
components:
schemas:
@@ -1957,6 +1957,8 @@ components:
- PaymentFee
- Remainder
- SchemeFee
- Surcharge
- Tip
- TopUp
- VAT
type: string
@@ -2121,6 +2123,56 @@ components:
description: The unique identifier of the original transfer.
type: string
type: object
RoutingDetails:
additionalProperties: false
properties:
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
errorCode:
description: A code that identifies the problem type.
type: string
priority:
description: 'The priority for the bank transfer. This sets the speed at
which the transfer is sent and the fees that you have to pay. Required
for transfers with `category` **bank**.
Possible values:
* **regular**: For normal, low-value transactions.
* **fast**: Faster way to transfer funds but has higher fees. Recommended
for high-priority, low-value transactions.
* **wire**: Fastest way to transfer funds but has the highest fees. Recommended
for high-priority, high-value transactions.
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).
* **crossBorder**: High-value transfer to a recipient in a different country.
* **internal**: Transfer to an Adyen-issued business bank account (by
bank account number/IBAN).'
enum:
- crossBorder
- fast
- instant
- internal
- regular
- wire
type: string
title:
description: A short, human-readable summary of the problem type.
type: string
type: object
SELocalAccountIdentification:
additionalProperties: false
properties:
@@ -2479,10 +2531,9 @@ components:
description: " A reference that is sent to the recipient. This reference\
\ is also sent in all webhooks related to the transfer, so you can use\
\ it to track statuses for both the source and recipient of funds.\n\n\
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
\ Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends\
\ on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**:\
\ 35 characters when transferring to an IBAN, 15 characters for others."
maxLength: 80
type: string
status:
x-addedInVersion: '2'
@@ -2734,10 +2785,9 @@ components:
description: " A reference that is sent to the recipient. This reference\
\ is also sent in all webhooks related to the transfer, so you can use\
\ it to track statuses for both the source and recipient of funds.\n\n\
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
\ Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends\
\ on the `category`.\n\n - **internal**: 80 characters\n\n- **bank**:\
\ 35 characters when transferring to an IBAN, 15 characters for others."
maxLength: 80
type: string
sequenceNumber:
x-addedInVersion: '3'
@@ -2899,10 +2949,6 @@ components:
type: string
estimatedArrivalTime:
x-addedInVersion: '3'
deprecated: true
x-deprecatedInVersion: '4'
x-deprecatedMessage: This property will be removed in v5 and replaced by
the [trackingData.estimatedArrivalTime](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.updated#request-data-tracking-EstimationTrackingData).
description: The estimated time the beneficiary should have access to the
funds.
format: date-time
@@ -3152,7 +3198,6 @@ components:
\ Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length\
\ depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**:\
\ 35 characters when transferring to an IBAN, 15 characters for others."
maxLength: 80
type: string
ultimateParty:
x-addedInVersion: '3'
@@ -3215,6 +3260,56 @@ components:
description: The type of the validation fact.
type: string
type: object
TransferServiceRestServiceError:
additionalProperties: false
properties:
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
errorCode:
description: A code that identifies the problem type.
type: string
instance:
description: A unique URI that identifies the specific occurrence of the
problem.
type: string
invalidFields:
description: Detailed explanation of each validation error, when applicable.
items:
$ref: '#/components/schemas/InvalidField'
type: array
requestId:
description: A unique reference for the request, essentially the same as
`pspReference`.
type: string
response:
description: JSON response payload.
$ref: '#/components/schemas/JSONObject'
routingDetails:
description: Detailed explanation of each attempt to route the transfer
with the priorities from the request.
items:
$ref: '#/components/schemas/RoutingDetails'
type: array
status:
description: The HTTP status code.
format: int32
type: integer
title:
description: A short, human-readable summary of the problem type.
type: string
type:
description: A URI that identifies the problem type, pointing to human-readable
documentation on this problem type.
type: string
required:
- type
- errorCode
- title
- detail
- status
type: object
TransferView:
additionalProperties: false
properties: