From fa609106635836a668051b7bb3f7c51d3ff21f4b Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Wed, 21 May 2025 13:37:13 +0200 Subject: [PATCH] spec release --- json/BalancePlatformAcsNotification-v1.json | 14 ++-- ...rmRelayedAuthorisationNotification-v1.json | 2 +- ...rmRelayedAuthorisationNotification-v2.json | 2 +- ...rmRelayedAuthorisationNotification-v4.json | 2 +- ...alancePlatformTransferNotification-v3.json | 20 ++++++ ...alancePlatformTransferNotification-v4.json | 20 ++++++ json/TransferService-v1.json | 2 + json/TransferService-v2.json | 2 + json/TransferService-v3.json | 27 ++++++++ json/TransferService-v4.json | 34 ++++++++++ yaml/BalancePlatformAcsNotification-v1.yaml | 16 ++--- ...rmRelayedAuthorisationNotification-v1.yaml | 3 +- ...rmRelayedAuthorisationNotification-v2.yaml | 3 +- ...rmRelayedAuthorisationNotification-v4.yaml | 3 +- ...alancePlatformTransferNotification-v3.yaml | 35 ++++++++++ ...alancePlatformTransferNotification-v4.yaml | 35 ++++++++++ yaml/TransferService-v1.yaml | 2 + yaml/TransferService-v2.yaml | 2 + yaml/TransferService-v3.yaml | 52 ++++++++++++++ yaml/TransferService-v4.yaml | 68 +++++++++++++++++++ 20 files changed, 323 insertions(+), 21 deletions(-) diff --git a/json/BalancePlatformAcsNotification-v1.json b/json/BalancePlatformAcsNotification-v1.json index 27d6453..621352f 100644 --- a/json/BalancePlatformAcsNotification-v1.json +++ b/json/BalancePlatformAcsNotification-v1.json @@ -375,7 +375,7 @@ "additionalProperties" : false, "properties" : { "authentication" : { - "description" : "Information about the authentication.", + "description" : "Contains information about the authentication.", "$ref" : "#/components/schemas/AuthenticationInfo" }, "balancePlatform" : { @@ -383,15 +383,15 @@ "type" : "string" }, "id" : { - "description" : "Unique identifier of the authentication.", + "description" : "The unique identifier of the authentication.", "type" : "string" }, "paymentInstrumentId" : { - "description" : "Unique identifier of the payment instrument that was used for the authentication.", + "description" : "The unique identifier of the payment instrument that was used for the authentication.", "type" : "string" }, "purchase" : { - "description" : "Information about the purchase.", + "description" : "Contains information about the purchase.", "$ref" : "#/components/schemas/PurchaseInfo" }, "status" : { @@ -535,15 +535,15 @@ "additionalProperties" : false, "properties" : { "date" : { - "description" : "Date of the purchase.", + "description" : "The date of the purchase.", "type" : "string" }, "merchantName" : { - "description" : "Name of the merchant.", + "description" : "The name of the business that the cardholder purchased from.", "type" : "string" }, "originalAmount" : { - "description" : "Amount of the purchase.", + "description" : "The amount of the purchase.", "$ref" : "#/components/schemas/Amount" } }, diff --git a/json/BalancePlatformRelayedAuthorisationNotification-v1.json b/json/BalancePlatformRelayedAuthorisationNotification-v1.json index 5877d74..5767cfa 100644 --- a/json/BalancePlatformRelayedAuthorisationNotification-v1.json +++ b/json/BalancePlatformRelayedAuthorisationNotification-v1.json @@ -444,7 +444,7 @@ "type" : "string" }, "threeDSecure" : { - "description" : "Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**.\n>Reach out to your Adyen contact to get the values relevant for your integration.", + "description" : "Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**.\n> Reach out to your Adyen contact to get the values relevant for your integration.", "type" : "string" } }, diff --git a/json/BalancePlatformRelayedAuthorisationNotification-v2.json b/json/BalancePlatformRelayedAuthorisationNotification-v2.json index 069a46a..bc5c996 100644 --- a/json/BalancePlatformRelayedAuthorisationNotification-v2.json +++ b/json/BalancePlatformRelayedAuthorisationNotification-v2.json @@ -405,7 +405,7 @@ "type" : "string" }, "threeDSecure" : { - "description" : "Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**.\n>Reach out to your Adyen contact to get the values relevant for your integration.", + "description" : "Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**.\n> Reach out to your Adyen contact to get the values relevant for your integration.", "type" : "string" } }, diff --git a/json/BalancePlatformRelayedAuthorisationNotification-v4.json b/json/BalancePlatformRelayedAuthorisationNotification-v4.json index 80e23b0..bfcb91e 100644 --- a/json/BalancePlatformRelayedAuthorisationNotification-v4.json +++ b/json/BalancePlatformRelayedAuthorisationNotification-v4.json @@ -415,7 +415,7 @@ "type" : "string" }, "threeDSecure" : { - "description" : "Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**.\n>Reach out to your Adyen contact to get the values relevant for your integration.", + "description" : "Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**.\n> Reach out to your Adyen contact to get the values relevant for your integration.", "type" : "string" } }, diff --git a/json/BalancePlatformTransferNotification-v3.json b/json/BalancePlatformTransferNotification-v3.json index 053b332..558cab8 100644 --- a/json/BalancePlatformTransferNotification-v3.json +++ b/json/BalancePlatformTransferNotification-v3.json @@ -654,6 +654,21 @@ ], "type" : "object" }, + "ExecutionDate" : { + "additionalProperties" : false, + "properties" : { + "date" : { + "description" : "The date when the transfer will be processed. This date must be:\n* Within 30 days of the current date.\n* In the [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) **YYYY-MM-DD**. For example: 2025-01-31", + "format" : "date", + "type" : "string" + }, + "timezone" : { + "description" : "The timezone that applies to the execution date. Use a timezone identifier from the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\nExample: **America/Los_Angeles**.\n Default value: **Europe/Amsterdam**.", + "type" : "string" + } + }, + "type" : "object" + }, "ExternalReason" : { "additionalProperties" : false, "properties" : { @@ -1391,6 +1406,11 @@ }, "type" : "array" }, + "executionDate" : { + "x-addedInVersion" : "3", + "description" : "Contains information about the date when the transfer will be processed. The execution date must be within 30 days of the current date.\n\nUntil the execution date:\n- The `status` of the transfer remains as **received**.\n- The `reason` of the transfer remains as **pending**.\n\n", + "$ref" : "#/components/schemas/ExecutionDate" + }, "externalReason" : { "x-addedInVersion" : "3", "description" : "The external reason of this transfer.", diff --git a/json/BalancePlatformTransferNotification-v4.json b/json/BalancePlatformTransferNotification-v4.json index 6b67350..0663d8e 100644 --- a/json/BalancePlatformTransferNotification-v4.json +++ b/json/BalancePlatformTransferNotification-v4.json @@ -735,6 +735,21 @@ ], "type" : "object" }, + "ExecutionDate" : { + "additionalProperties" : false, + "properties" : { + "date" : { + "description" : "The date when the transfer will be processed. This date must be:\n* Within 30 days of the current date.\n* In the [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) **YYYY-MM-DD**. For example: 2025-01-31", + "format" : "date", + "type" : "string" + }, + "timezone" : { + "description" : "The timezone that applies to the execution date. Use a timezone identifier from the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\nExample: **America/Los_Angeles**.\n Default value: **Europe/Amsterdam**.", + "type" : "string" + } + }, + "type" : "object" + }, "ExternalReason" : { "additionalProperties" : false, "properties" : { @@ -1747,6 +1762,11 @@ }, "type" : "array" }, + "executionDate" : { + "x-addedInVersion" : "3", + "description" : "Contains information about the date when the transfer will be processed. The execution date must be within 30 days of the current date.\n\nUntil the execution date:\n- The `status` of the transfer remains as **received**.\n- The `reason` of the transfer remains as **pending**.\n\n", + "$ref" : "#/components/schemas/ExecutionDate" + }, "externalReason" : { "x-addedInVersion" : "3", "description" : "The external reason of this transfer.", diff --git a/json/TransferService-v1.json b/json/TransferService-v1.json index 107f367..2c387d0 100644 --- a/json/TransferService-v1.json +++ b/json/TransferService-v1.json @@ -813,6 +813,7 @@ "bank", "card", "grants", + "interest", "internal", "issuedCard", "migration", @@ -912,6 +913,7 @@ "grant", "installment", "installmentReversal", + "interestPayout", "internalDirectDebit", "internalTransfer", "invoiceDeduction", diff --git a/json/TransferService-v2.json b/json/TransferService-v2.json index c93ab15..d7ae6bb 100644 --- a/json/TransferService-v2.json +++ b/json/TransferService-v2.json @@ -838,6 +838,7 @@ "bank", "card", "grants", + "interest", "internal", "issuedCard", "migration", @@ -937,6 +938,7 @@ "grant", "installment", "installmentReversal", + "interestPayout", "internalDirectDebit", "internalTransfer", "invoiceDeduction", diff --git a/json/TransferService-v3.json b/json/TransferService-v3.json index b4895a2..de242ed 100644 --- a/json/TransferService-v3.json +++ b/json/TransferService-v3.json @@ -1738,6 +1738,21 @@ }, "type" : "object" }, + "ExecutionDate" : { + "additionalProperties" : false, + "properties" : { + "date" : { + "description" : "The date when the transfer will be processed. This date must be:\n* Within 30 days of the current date.\n* In the [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) **YYYY-MM-DD**. For example: 2025-01-31", + "format" : "date", + "type" : "string" + }, + "timezone" : { + "description" : "The timezone that applies to the execution date. Use a timezone identifier from the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\nExample: **America/Los_Angeles**.\n Default value: **Europe/Amsterdam**.", + "type" : "string" + } + }, + "type" : "object" + }, "Fee" : { "additionalProperties" : false, "properties" : { @@ -2428,6 +2443,7 @@ "bank", "card", "grants", + "interest", "internal", "issuedCard", "migration", @@ -2535,6 +2551,7 @@ "grant", "installment", "installmentReversal", + "interestPayout", "internalDirectDebit", "internalTransfer", "invoiceDeduction", @@ -2660,6 +2677,11 @@ ], "type" : "string" }, + "executionDate" : { + "x-addedInVersion" : "3", + "description" : "Contains information about the date when the transfer will be processed. The execution date must be within 30 days of the current date.\n\nUntil the execution date:\n- The `status` of the transfer remains as **received**.\n- The `reason` of the transfer remains as **pending**.\n\n", + "$ref" : "#/components/schemas/ExecutionDate" + }, "id" : { "description" : "The ID of the resource.", "type" : "string" @@ -2901,6 +2923,11 @@ "maxLength" : 140, "type" : "string" }, + "executionDate" : { + "x-addedInVersion" : "3", + "description" : "The date when the transfer will be processed. This date must be within 30 days of the current date.\n\nUntil the `executionDate`:\n- The `status` of the transfer remains as **received**.\n- The `reason` of the transfer remains as **pending**.\n\n", + "$ref" : "#/components/schemas/ExecutionDate" + }, "paymentInstrumentId" : { "description" : "The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-id).\n\nIf you want to make a transfer using a **virtual** **bankAccount**, you must specify the payment instrument ID of the **virtual** **bankAccount**. If you only specify a balance account ID, Adyen uses the default **physical** **bankAccount** payment instrument assigned to the balance account.", "type" : "string" diff --git a/json/TransferService-v4.json b/json/TransferService-v4.json index 6e18d5c..ac3fdad 100644 --- a/json/TransferService-v4.json +++ b/json/TransferService-v4.json @@ -748,12 +748,16 @@ }, { "value" : "upgrade" + }, + { + "value" : "interest" } ], "enum" : [ "bank", "card", "grants", + "interest", "internal", "issuedCard", "migration", @@ -2258,6 +2262,21 @@ ], "type" : "object" }, + "ExecutionDate" : { + "additionalProperties" : false, + "properties" : { + "date" : { + "description" : "The date when the transfer will be processed. This date must be:\n* Within 30 days of the current date.\n* In the [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) **YYYY-MM-DD**. For example: 2025-01-31", + "format" : "date", + "type" : "string" + }, + "timezone" : { + "description" : "The timezone that applies to the execution date. Use a timezone identifier from the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\nExample: **America/Los_Angeles**.\n Default value: **Europe/Amsterdam**.", + "type" : "string" + } + }, + "type" : "object" + }, "ExternalReason" : { "additionalProperties" : false, "properties" : { @@ -3618,6 +3637,11 @@ ], "type" : "string" }, + "executionDate" : { + "x-addedInVersion" : "3", + "description" : "Contains information about the date when the transfer will be processed. The execution date must be within 30 days of the current date.\n\nUntil the execution date:\n- The `status` of the transfer remains as **received**.\n- The `reason` of the transfer remains as **pending**.\n\n", + "$ref" : "#/components/schemas/ExecutionDate" + }, "id" : { "description" : "The ID of the resource.", "type" : "string" @@ -3906,6 +3930,11 @@ }, "type" : "array" }, + "executionDate" : { + "x-addedInVersion" : "3", + "description" : "Contains information about the date when the transfer will be processed. The execution date must be within 30 days of the current date.\n\nUntil the execution date:\n- The `status` of the transfer remains as **received**.\n- The `reason` of the transfer remains as **pending**.\n\n", + "$ref" : "#/components/schemas/ExecutionDate" + }, "externalReason" : { "x-addedInVersion" : "3", "description" : "The external reason of this transfer.", @@ -4381,6 +4410,11 @@ "maxLength" : 140, "type" : "string" }, + "executionDate" : { + "x-addedInVersion" : "3", + "description" : "The date when the transfer will be processed. This date must be within 30 days of the current date.\n\nUntil the `executionDate`:\n- The `status` of the transfer remains as **received**.\n- The `reason` of the transfer remains as **pending**.\n\n", + "$ref" : "#/components/schemas/ExecutionDate" + }, "paymentInstrumentId" : { "description" : "The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-id).\n\nIf you want to make a transfer using a **virtual** **bankAccount**, you must specify the payment instrument ID of the **virtual** **bankAccount**. If you only specify a balance account ID, Adyen uses the default **physical** **bankAccount** payment instrument assigned to the balance account.", "type" : "string" diff --git a/yaml/BalancePlatformAcsNotification-v1.yaml b/yaml/BalancePlatformAcsNotification-v1.yaml index cd03c0b..c2a41e5 100644 --- a/yaml/BalancePlatformAcsNotification-v1.yaml +++ b/yaml/BalancePlatformAcsNotification-v1.yaml @@ -371,20 +371,20 @@ components: additionalProperties: false properties: authentication: - description: Information about the authentication. + description: Contains information about the authentication. $ref: '#/components/schemas/AuthenticationInfo' balancePlatform: description: The unique identifier of the balance platform. type: string id: - description: Unique identifier of the authentication. + description: The unique identifier of the authentication. type: string paymentInstrumentId: - description: Unique identifier of the payment instrument that was used for - the authentication. + description: The unique identifier of the payment instrument that was used + for the authentication. type: string purchase: - description: Information about the purchase. + description: Contains information about the purchase. $ref: '#/components/schemas/PurchaseInfo' status: description: 'Outcome of the authentication. @@ -521,13 +521,13 @@ components: additionalProperties: false properties: date: - description: Date of the purchase. + description: The date of the purchase. type: string merchantName: - description: Name of the merchant. + description: The name of the business that the cardholder purchased from. type: string originalAmount: - description: Amount of the purchase. + description: The amount of the purchase. $ref: '#/components/schemas/Amount' required: - merchantName diff --git a/yaml/BalancePlatformRelayedAuthorisationNotification-v1.yaml b/yaml/BalancePlatformRelayedAuthorisationNotification-v1.yaml index 764caab..72bd59a 100644 --- a/yaml/BalancePlatformRelayedAuthorisationNotification-v1.yaml +++ b/yaml/BalancePlatformRelayedAuthorisationNotification-v1.yaml @@ -411,7 +411,8 @@ components: description: 'Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**. - >Reach out to your Adyen contact to get the values relevant for your integration.' + > Reach out to your Adyen contact to get the values relevant for your + integration.' type: string required: - formFactor diff --git a/yaml/BalancePlatformRelayedAuthorisationNotification-v2.yaml b/yaml/BalancePlatformRelayedAuthorisationNotification-v2.yaml index db680e4..65bf4fe 100644 --- a/yaml/BalancePlatformRelayedAuthorisationNotification-v2.yaml +++ b/yaml/BalancePlatformRelayedAuthorisationNotification-v2.yaml @@ -370,7 +370,8 @@ components: description: 'Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**. - >Reach out to your Adyen contact to get the values relevant for your integration.' + > Reach out to your Adyen contact to get the values relevant for your + integration.' type: string required: - formFactor diff --git a/yaml/BalancePlatformRelayedAuthorisationNotification-v4.yaml b/yaml/BalancePlatformRelayedAuthorisationNotification-v4.yaml index e69a35b..6ae4961 100644 --- a/yaml/BalancePlatformRelayedAuthorisationNotification-v4.yaml +++ b/yaml/BalancePlatformRelayedAuthorisationNotification-v4.yaml @@ -376,7 +376,8 @@ components: description: 'Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**. - >Reach out to your Adyen contact to get the values relevant for your integration.' + > Reach out to your Adyen contact to get the values relevant for your + integration.' type: string required: - formFactor diff --git a/yaml/BalancePlatformTransferNotification-v3.yaml b/yaml/BalancePlatformTransferNotification-v3.yaml index 7bf8396..9230057 100644 --- a/yaml/BalancePlatformTransferNotification-v3.yaml +++ b/yaml/BalancePlatformTransferNotification-v3.yaml @@ -562,6 +562,25 @@ components: - type - estimatedArrivalTime type: object + ExecutionDate: + additionalProperties: false + properties: + date: + description: 'The date when the transfer will be processed. This date must + be: + + * Within 30 days of the current date. + + * In the [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) + **YYYY-MM-DD**. For example: 2025-01-31' + format: date + type: string + timezone: + description: "The timezone that applies to the execution date. Use a timezone\ + \ identifier from the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\ + \nExample: **America/Los_Angeles**.\n Default value: **Europe/Amsterdam**." + type: string + type: object ExternalReason: additionalProperties: false properties: @@ -1208,6 +1227,22 @@ components: items: $ref: '#/components/schemas/TransferEvent' type: array + executionDate: + x-addedInVersion: '3' + description: 'Contains information about the date when the transfer will + be processed. The execution date must be within 30 days of the current + date. + + + Until the execution date: + + - The `status` of the transfer remains as **received**. + + - The `reason` of the transfer remains as **pending**. + + + ' + $ref: '#/components/schemas/ExecutionDate' externalReason: x-addedInVersion: '3' description: The external reason of this transfer. diff --git a/yaml/BalancePlatformTransferNotification-v4.yaml b/yaml/BalancePlatformTransferNotification-v4.yaml index 599a2c8..b1a5ac7 100644 --- a/yaml/BalancePlatformTransferNotification-v4.yaml +++ b/yaml/BalancePlatformTransferNotification-v4.yaml @@ -646,6 +646,25 @@ components: - type - estimatedArrivalTime type: object + ExecutionDate: + additionalProperties: false + properties: + date: + description: 'The date when the transfer will be processed. This date must + be: + + * Within 30 days of the current date. + + * In the [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) + **YYYY-MM-DD**. For example: 2025-01-31' + format: date + type: string + timezone: + description: "The timezone that applies to the execution date. Use a timezone\ + \ identifier from the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\ + \nExample: **America/Los_Angeles**.\n Default value: **Europe/Amsterdam**." + type: string + type: object ExternalReason: additionalProperties: false properties: @@ -1575,6 +1594,22 @@ components: items: $ref: '#/components/schemas/TransferEvent' type: array + executionDate: + x-addedInVersion: '3' + description: 'Contains information about the date when the transfer will + be processed. The execution date must be within 30 days of the current + date. + + + Until the execution date: + + - The `status` of the transfer remains as **received**. + + - The `reason` of the transfer remains as **pending**. + + + ' + $ref: '#/components/schemas/ExecutionDate' externalReason: x-addedInVersion: '3' description: The external reason of this transfer. diff --git a/yaml/TransferService-v1.yaml b/yaml/TransferService-v1.yaml index adb5341..4a3bb85 100644 --- a/yaml/TransferService-v1.yaml +++ b/yaml/TransferService-v1.yaml @@ -692,6 +692,7 @@ components: - bank - card - grants + - interest - internal - issuedCard - migration @@ -792,6 +793,7 @@ components: - grant - installment - installmentReversal + - interestPayout - internalDirectDebit - internalTransfer - invoiceDeduction diff --git a/yaml/TransferService-v2.yaml b/yaml/TransferService-v2.yaml index a196112..b4e1df2 100644 --- a/yaml/TransferService-v2.yaml +++ b/yaml/TransferService-v2.yaml @@ -753,6 +753,7 @@ components: - bank - card - grants + - interest - internal - issuedCard - migration @@ -853,6 +854,7 @@ components: - grant - installment - installmentReversal + - interestPayout - internalDirectDebit - internalTransfer - invoiceDeduction diff --git a/yaml/TransferService-v3.yaml b/yaml/TransferService-v3.yaml index 9efa4fb..a325148 100644 --- a/yaml/TransferService-v3.yaml +++ b/yaml/TransferService-v3.yaml @@ -1330,6 +1330,25 @@ components: Possible values: **OneOff**, **First**, **Recurring**, **Final**.' type: string type: object + ExecutionDate: + additionalProperties: false + properties: + date: + description: 'The date when the transfer will be processed. This date must + be: + + * Within 30 days of the current date. + + * In the [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) + **YYYY-MM-DD**. For example: 2025-01-31' + format: date + type: string + timezone: + description: "The timezone that applies to the execution date. Use a timezone\ + \ identifier from the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\ + \nExample: **America/Los_Angeles**.\n Default value: **Europe/Amsterdam**." + type: string + type: object Fee: additionalProperties: false properties: @@ -1936,6 +1955,7 @@ components: - bank - card - grants + - interest - internal - issuedCard - migration @@ -2043,6 +2063,7 @@ components: - grant - installment - installmentReversal + - interestPayout - internalDirectDebit - internalTransfer - invoiceDeduction @@ -2169,6 +2190,22 @@ components: - incoming - outgoing type: string + executionDate: + x-addedInVersion: '3' + description: 'Contains information about the date when the transfer will + be processed. The execution date must be within 30 days of the current + date. + + + Until the execution date: + + - The `status` of the transfer remains as **received**. + + - The `reason` of the transfer remains as **pending**. + + + ' + $ref: '#/components/schemas/ExecutionDate' id: description: The ID of the resource. type: string @@ -2451,6 +2488,21 @@ components: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ '' " ! ?**' maxLength: 140 type: string + executionDate: + x-addedInVersion: '3' + description: 'The date when the transfer will be processed. This date must + be within 30 days of the current date. + + + Until the `executionDate`: + + - The `status` of the transfer remains as **received**. + + - The `reason` of the transfer remains as **pending**. + + + ' + $ref: '#/components/schemas/ExecutionDate' paymentInstrumentId: description: 'The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-id). diff --git a/yaml/TransferService-v4.yaml b/yaml/TransferService-v4.yaml index 804e54d..636df32 100644 --- a/yaml/TransferService-v4.yaml +++ b/yaml/TransferService-v4.yaml @@ -577,10 +577,12 @@ paths: - value: migration - value: card - value: upgrade + - value: interest enum: - bank - card - grants + - interest - internal - issuedCard - migration @@ -1764,6 +1766,25 @@ components: - type - estimatedArrivalTime type: object + ExecutionDate: + additionalProperties: false + properties: + date: + description: 'The date when the transfer will be processed. This date must + be: + + * Within 30 days of the current date. + + * In the [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html) + **YYYY-MM-DD**. For example: 2025-01-31' + format: date + type: string + timezone: + description: "The timezone that applies to the execution date. Use a timezone\ + \ identifier from the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\ + \nExample: **America/Los_Angeles**.\n Default value: **Europe/Amsterdam**." + type: string + type: object ExternalReason: additionalProperties: false properties: @@ -3008,6 +3029,22 @@ components: - incoming - outgoing type: string + executionDate: + x-addedInVersion: '3' + description: 'Contains information about the date when the transfer will + be processed. The execution date must be within 30 days of the current + date. + + + Until the execution date: + + - The `status` of the transfer remains as **received**. + + - The `reason` of the transfer remains as **pending**. + + + ' + $ref: '#/components/schemas/ExecutionDate' id: description: The ID of the resource. type: string @@ -3289,6 +3326,22 @@ components: items: $ref: '#/components/schemas/TransferEvent' type: array + executionDate: + x-addedInVersion: '3' + description: 'Contains information about the date when the transfer will + be processed. The execution date must be within 30 days of the current + date. + + + Until the execution date: + + - The `status` of the transfer remains as **received**. + + - The `reason` of the transfer remains as **pending**. + + + ' + $ref: '#/components/schemas/ExecutionDate' externalReason: x-addedInVersion: '3' description: The external reason of this transfer. @@ -3744,6 +3797,21 @@ components: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ '' " ! ?**' maxLength: 140 type: string + executionDate: + x-addedInVersion: '3' + description: 'The date when the transfer will be processed. This date must + be within 30 days of the current date. + + + Until the `executionDate`: + + - The `status` of the transfer remains as **received**. + + - The `reason` of the transfer remains as **pending**. + + + ' + $ref: '#/components/schemas/ExecutionDate' paymentInstrumentId: description: 'The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-id).