Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Jun 5, 2024
1 parent 85b8ffc commit ee0f2d9
Show file tree
Hide file tree
Showing 16 changed files with 863 additions and 121 deletions.
2 changes: 1 addition & 1 deletion json/BalancePlatformAcsNotification-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
},
Expand Down
4 changes: 3 additions & 1 deletion json/BalancePlatformPaymentNotification-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -949,6 +949,8 @@
"PaymentFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"TopUp",
"VAT"
],
Expand Down
7 changes: 4 additions & 3 deletions json/BalancePlatformTransferNotification-v3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -1370,6 +1370,8 @@
"PaymentFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"TopUp",
"VAT"
],
Expand Down Expand Up @@ -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" : {
Expand Down
10 changes: 4 additions & 6 deletions json/BalancePlatformTransferNotification-v4.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -1174,6 +1174,8 @@
"PaymentFee",
"Remainder",
"SchemeFee",
"Surcharge",
"Tip",
"TopUp",
"VAT"
],
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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"
Expand Down
100 changes: 95 additions & 5 deletions json/TransferService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
Expand All @@ -375,7 +375,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
Expand All @@ -385,7 +385,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
"$ref" : "#/components/schemas/TransferServiceRestServiceError"
}
}
},
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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"
},
Expand Down Expand Up @@ -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"
},
Expand Down Expand Up @@ -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" : {
Expand Down
Loading

0 comments on commit ee0f2d9

Please sign in to comment.