From 5537d1ad1a968fcd3f468c0bb636c43186e850db Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Thu, 13 Jun 2024 19:47:31 +0200 Subject: [PATCH] spec release --- json/TransferService-v2.json | 4 ++-- json/TransferService-v3.json | 4 ++-- json/TransferService-v4.json | 4 ++-- yaml/TransferService-v2.yaml | 17 +++++++++++++++-- yaml/TransferService-v3.yaml | 17 +++++++++++++++-- yaml/TransferService-v4.yaml | 17 +++++++++++++++-- 6 files changed, 51 insertions(+), 12 deletions(-) diff --git a/json/TransferService-v2.json b/json/TransferService-v2.json index 6fe9ee91..675633d6 100644 --- a/json/TransferService-v2.json +++ b/json/TransferService-v2.json @@ -1147,7 +1147,7 @@ "$ref" : "#/components/schemas/Amount" }, "balanceAccountId" : { - "description" : "The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).", + "description" : "The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).\n\nIf you want to make a transfer using a **virtual** **bankAccount** assigned to the balance account, you must specify the [payment instrument ID](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-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" }, "bank" : { @@ -1166,7 +1166,7 @@ "type" : "string" }, "paymentInstrumentId" : { - "description" : "The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).", + "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" }, "reference" : { diff --git a/json/TransferService-v3.json b/json/TransferService-v3.json index 9197787d..a3a0edd6 100644 --- a/json/TransferService-v3.json +++ b/json/TransferService-v3.json @@ -2480,7 +2480,7 @@ "$ref" : "#/components/schemas/Amount" }, "balanceAccountId" : { - "description" : "The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).", + "description" : "The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).\n\nIf you want to make a transfer using a **virtual** **bankAccount** assigned to the balance account, you must specify the [payment instrument ID](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-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" }, "category" : { @@ -2507,7 +2507,7 @@ "type" : "string" }, "paymentInstrumentId" : { - "description" : "The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).", + "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" }, "priority" : { diff --git a/json/TransferService-v4.json b/json/TransferService-v4.json index 623407ac..44860c05 100644 --- a/json/TransferService-v4.json +++ b/json/TransferService-v4.json @@ -3738,7 +3738,7 @@ "$ref" : "#/components/schemas/Amount" }, "balanceAccountId" : { - "description" : "The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).", + "description" : "The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).\n\nIf you want to make a transfer using a **virtual** **bankAccount** assigned to the balance account, you must specify the [payment instrument ID](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-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" }, "category" : { @@ -3765,7 +3765,7 @@ "type" : "string" }, "paymentInstrumentId" : { - "description" : "The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).", + "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" }, "priority" : { diff --git a/yaml/TransferService-v2.yaml b/yaml/TransferService-v2.yaml index 5ff59c0f..7ee5f07b 100644 --- a/yaml/TransferService-v2.yaml +++ b/yaml/TransferService-v2.yaml @@ -1044,7 +1044,14 @@ components: description: The amount of the transfer. $ref: '#/components/schemas/Amount' balanceAccountId: - description: The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). + description: 'The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). + + + If you want to make a transfer using a **virtual** **bankAccount** assigned + to the balance account, you must specify the [payment instrument ID](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-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 bank: x-addedInVersion: '1' @@ -1071,7 +1078,13 @@ components: maxLength: 140 type: string paymentInstrumentId: - description: The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id). + description: 'The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-id). + + + If 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 reference: x-addedInVersion: '2' diff --git a/yaml/TransferService-v3.yaml b/yaml/TransferService-v3.yaml index 6b7005a9..c07e60be 100644 --- a/yaml/TransferService-v3.yaml +++ b/yaml/TransferService-v3.yaml @@ -2056,7 +2056,14 @@ components: description: The amount of the transfer. $ref: '#/components/schemas/Amount' balanceAccountId: - description: The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). + description: 'The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). + + + If you want to make a transfer using a **virtual** **bankAccount** assigned + to the balance account, you must specify the [payment instrument ID](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-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 category: x-addedInVersion: '3' @@ -2093,7 +2100,13 @@ components: maxLength: 140 type: string paymentInstrumentId: - description: The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id). + description: 'The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-id). + + + If 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 priority: x-addedInVersion: '3' diff --git a/yaml/TransferService-v4.yaml b/yaml/TransferService-v4.yaml index f73ce85e..603e3340 100644 --- a/yaml/TransferService-v4.yaml +++ b/yaml/TransferService-v4.yaml @@ -3110,7 +3110,14 @@ components: description: The amount of the transfer. $ref: '#/components/schemas/Amount' balanceAccountId: - description: The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). + description: 'The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id). + + + If you want to make a transfer using a **virtual** **bankAccount** assigned + to the balance account, you must specify the [payment instrument ID](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-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 category: x-addedInVersion: '3' @@ -3147,7 +3154,13 @@ components: maxLength: 140 type: string paymentInstrumentId: - description: The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id). + description: 'The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/paymentInstruments#responses-200-id). + + + If 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 priority: x-addedInVersion: '3'