diff --git a/json/BalancePlatformTransferNotification-v3.json b/json/BalancePlatformTransferNotification-v3.json index ad35b058..a8780ba7 100644 --- a/json/BalancePlatformTransferNotification-v3.json +++ b/json/BalancePlatformTransferNotification-v3.json @@ -466,7 +466,7 @@ "additionalProperties" : false, "properties" : { "status" : { - "description" : "Possible values:\n\n - **credited**: Transfer is credited to beneficiary.", + "description" : "The status of the transfer.\n\nPossible values:\n\n - **credited**: the funds are credited to your user's transfer instrument or bank account.", "enum" : [ "credited" ], @@ -474,7 +474,7 @@ }, "type" : { "default" : "confirmation", - "description" : "**confirmation**", + "description" : "The type of the tracking event.\n\nPossible values:\n\n - **confirmation**: the transfer passed Adyen's internal review.", "enum" : [ "confirmation" ], @@ -550,7 +550,7 @@ }, "type" : { "default" : "estimation", - "description" : "**estimation**", + "description" : "The type of tracking event. \n\nPossible values: \n\n- **estimation**: the estimated date and time of when the funds will be credited has been determined.", "enum" : [ "estimation" ], @@ -662,14 +662,14 @@ "additionalProperties" : false, "properties" : { "reason" : { - "description" : "Possible values:\n\n - **refusedForRegulatoryReasons**.", + "description" : "The reason why the transfer failed Adyen's internal review. \n\nPossible values:\n\n- **refusedForRegulatoryReasons**: the transfer does not comply with Adyen's risk policy. For more information, [contact the Support Team](https://www.adyen.help/hc/en-us/requests/new). ", "enum" : [ "refusedForRegulatoryReasons" ], "type" : "string" }, "status" : { - "description" : "Possible values:\n\n - **pending**: Transfer is under internal review.\n\n- **failed**: Transfer failed to pass internal review. See field **reason** for details.\n\n", + "description" : "The status of the transfer.\n\nPossible values:\n\n - **pending**: the transfer is under internal review.\n\n- **failed**: the transfer failed Adyen's internal review. For details, see `reason`.\n\n", "enum" : [ "pending", "failed" @@ -678,7 +678,7 @@ }, "type" : { "default" : "internalReview", - "description" : "**internalReview**", + "description" : "The type of tracking event. \n\nPossible values: \n\n - **internalReview**: the transfer was flagged because it does not comply with Adyen's risk policy.", "enum" : [ "internalReview" ], @@ -1538,7 +1538,7 @@ }, "tracking" : { "x-addedInVersion" : "3", - "description" : "Most recent tracking information for the transfer.", + "description" : "The latest tracking information of the transfer.", "oneOf" : [ { "$ref" : "#/components/schemas/ConfirmationTrackingData" diff --git a/json/BalancePlatformTransferNotification-v4.json b/json/BalancePlatformTransferNotification-v4.json index b40e0f0b..8f9cd142 100644 --- a/json/BalancePlatformTransferNotification-v4.json +++ b/json/BalancePlatformTransferNotification-v4.json @@ -493,7 +493,7 @@ "additionalProperties" : false, "properties" : { "status" : { - "description" : "Possible values:\n\n - **credited**: Transfer is credited to beneficiary.", + "description" : "The status of the transfer.\n\nPossible values:\n\n - **credited**: the funds are credited to your user's transfer instrument or bank account.", "enum" : [ "credited" ], @@ -501,7 +501,7 @@ }, "type" : { "default" : "confirmation", - "description" : "**confirmation**", + "description" : "The type of the tracking event.\n\nPossible values:\n\n - **confirmation**: the transfer passed Adyen's internal review.", "enum" : [ "confirmation" ], @@ -577,7 +577,7 @@ }, "type" : { "default" : "estimation", - "description" : "**estimation**", + "description" : "The type of tracking event. \n\nPossible values: \n\n- **estimation**: the estimated date and time of when the funds will be credited has been determined.", "enum" : [ "estimation" ], @@ -713,14 +713,14 @@ "additionalProperties" : false, "properties" : { "reason" : { - "description" : "Possible values:\n\n - **refusedForRegulatoryReasons**.", + "description" : "The reason why the transfer failed Adyen's internal review. \n\nPossible values:\n\n- **refusedForRegulatoryReasons**: the transfer does not comply with Adyen's risk policy. For more information, [contact the Support Team](https://www.adyen.help/hc/en-us/requests/new). ", "enum" : [ "refusedForRegulatoryReasons" ], "type" : "string" }, "status" : { - "description" : "Possible values:\n\n - **pending**: Transfer is under internal review.\n\n- **failed**: Transfer failed to pass internal review. See field **reason** for details.\n\n", + "description" : "The status of the transfer.\n\nPossible values:\n\n - **pending**: the transfer is under internal review.\n\n- **failed**: the transfer failed Adyen's internal review. For details, see `reason`.\n\n", "enum" : [ "pending", "failed" @@ -729,7 +729,7 @@ }, "type" : { "default" : "internalReview", - "description" : "**internalReview**", + "description" : "The type of tracking event. \n\nPossible values: \n\n - **internalReview**: the transfer was flagged because it does not comply with Adyen's risk policy.", "enum" : [ "internalReview" ], @@ -1618,7 +1618,7 @@ }, "tracking" : { "x-addedInVersion" : "3", - "description" : "Most recent tracking information for the transfer.", + "description" : "The latest tracking information of the transfer.", "oneOf" : [ { "$ref" : "#/components/schemas/ConfirmationTrackingData" @@ -1714,7 +1714,7 @@ "x-addedInVersion" : "3", "deprecated" : true, "x-deprecatedInVersion" : "4", - "x-deprecatedMessage" : "This will be removed in v5. Please use **trackingData.estimatedArrivalTime**.", + "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" diff --git a/json/TransferService-v4.json b/json/TransferService-v4.json index 2e02215b..f83f436d 100644 --- a/json/TransferService-v4.json +++ b/json/TransferService-v4.json @@ -1687,7 +1687,7 @@ "additionalProperties" : false, "properties" : { "status" : { - "description" : "Possible values:\n\n - **credited**: Transfer is credited to beneficiary.", + "description" : "The status of the transfer.\n\nPossible values:\n\n - **credited**: the funds are credited to your user's transfer instrument or bank account.", "enum" : [ "credited" ], @@ -1695,7 +1695,7 @@ }, "type" : { "default" : "confirmation", - "description" : "**confirmation**", + "description" : "The type of the tracking event.\n\nPossible values:\n\n - **confirmation**: the transfer passed Adyen's internal review.", "enum" : [ "confirmation" ], @@ -1807,7 +1807,7 @@ }, "type" : { "default" : "estimation", - "description" : "**estimation**", + "description" : "The type of tracking event. \n\nPossible values: \n\n- **estimation**: the estimated date and time of when the funds will be credited has been determined.", "enum" : [ "estimation" ], @@ -1973,14 +1973,14 @@ "additionalProperties" : false, "properties" : { "reason" : { - "description" : "Possible values:\n\n - **refusedForRegulatoryReasons**.", + "description" : "The reason why the transfer failed Adyen's internal review. \n\nPossible values:\n\n- **refusedForRegulatoryReasons**: the transfer does not comply with Adyen's risk policy. For more information, [contact the Support Team](https://www.adyen.help/hc/en-us/requests/new). ", "enum" : [ "refusedForRegulatoryReasons" ], "type" : "string" }, "status" : { - "description" : "Possible values:\n\n - **pending**: Transfer is under internal review.\n\n- **failed**: Transfer failed to pass internal review. See field **reason** for details.\n\n", + "description" : "The status of the transfer.\n\nPossible values:\n\n - **pending**: the transfer is under internal review.\n\n- **failed**: the transfer failed Adyen's internal review. For details, see `reason`.\n\n", "enum" : [ "pending", "failed" @@ -1989,7 +1989,7 @@ }, "type" : { "default" : "internalReview", - "description" : "**internalReview**", + "description" : "The type of tracking event. \n\nPossible values: \n\n - **internalReview**: the transfer was flagged because it does not comply with Adyen's risk policy.", "enum" : [ "internalReview" ], @@ -3433,7 +3433,7 @@ }, "tracking" : { "x-addedInVersion" : "3", - "description" : "Most recent tracking information for the transfer.", + "description" : "The latest tracking information of the transfer.", "oneOf" : [ { "$ref" : "#/components/schemas/ConfirmationTrackingData" @@ -3529,7 +3529,7 @@ "x-addedInVersion" : "3", "deprecated" : true, "x-deprecatedInVersion" : "4", - "x-deprecatedMessage" : "This will be removed in v5. Please use **trackingData.estimatedArrivalTime**.", + "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" diff --git a/yaml/BalancePlatformTransferNotification-v3.yaml b/yaml/BalancePlatformTransferNotification-v3.yaml index 7884f8f9..f2873d32 100644 --- a/yaml/BalancePlatformTransferNotification-v3.yaml +++ b/yaml/BalancePlatformTransferNotification-v3.yaml @@ -376,14 +376,15 @@ components: additionalProperties: false properties: status: - description: "Possible values:\n\n - **credited**: Transfer is credited\ - \ to beneficiary." + description: "The status of the transfer.\n\nPossible values:\n\n - **credited**:\ + \ the funds are credited to your user's transfer instrument or bank account." enum: - credited type: string type: default: confirmation - description: '**confirmation**' + description: "The type of the tracking event.\n\nPossible values:\n\n -\ + \ **confirmation**: the transfer passed Adyen's internal review." enum: - confirmation type: string @@ -443,7 +444,9 @@ components: type: string type: default: estimation - description: '**estimation**' + description: "The type of tracking event. \n\nPossible values: \n\n- **estimation**:\ + \ the estimated date and time of when the funds will be credited has been\ + \ determined." enum: - estimation type: string @@ -528,21 +531,26 @@ components: additionalProperties: false properties: reason: - description: "Possible values:\n\n - **refusedForRegulatoryReasons**." + description: "The reason why the transfer failed Adyen's internal review.\ + \ \n\nPossible values:\n\n- **refusedForRegulatoryReasons**: the transfer\ + \ does not comply with Adyen's risk policy. For more information, [contact\ + \ the Support Team](https://www.adyen.help/hc/en-us/requests/new). " enum: - refusedForRegulatoryReasons type: string status: - description: "Possible values:\n\n - **pending**: Transfer is under internal\ - \ review.\n\n- **failed**: Transfer failed to pass internal review. See\ - \ field **reason** for details.\n\n" + description: "The status of the transfer.\n\nPossible values:\n\n - **pending**:\ + \ the transfer is under internal review.\n\n- **failed**: the transfer\ + \ failed Adyen's internal review. For details, see `reason`.\n\n" enum: - pending - failed type: string type: default: internalReview - description: '**internalReview**' + description: "The type of tracking event. \n\nPossible values: \n\n - **internalReview**:\ + \ the transfer was flagged because it does not comply with Adyen's risk\ + \ policy." enum: - internalReview type: string @@ -1372,7 +1380,7 @@ components: type: string tracking: x-addedInVersion: '3' - description: Most recent tracking information for the transfer. + description: The latest tracking information of the transfer. oneOf: - $ref: '#/components/schemas/ConfirmationTrackingData' - $ref: '#/components/schemas/EstimationTrackingData' diff --git a/yaml/BalancePlatformTransferNotification-v4.yaml b/yaml/BalancePlatformTransferNotification-v4.yaml index e5fe4629..5b5ae5ee 100644 --- a/yaml/BalancePlatformTransferNotification-v4.yaml +++ b/yaml/BalancePlatformTransferNotification-v4.yaml @@ -423,14 +423,15 @@ components: additionalProperties: false properties: status: - description: "Possible values:\n\n - **credited**: Transfer is credited\ - \ to beneficiary." + description: "The status of the transfer.\n\nPossible values:\n\n - **credited**:\ + \ the funds are credited to your user's transfer instrument or bank account." enum: - credited type: string type: default: confirmation - description: '**confirmation**' + description: "The type of the tracking event.\n\nPossible values:\n\n -\ + \ **confirmation**: the transfer passed Adyen's internal review." enum: - confirmation type: string @@ -490,7 +491,9 @@ components: type: string type: default: estimation - description: '**estimation**' + description: "The type of tracking event. \n\nPossible values: \n\n- **estimation**:\ + \ the estimated date and time of when the funds will be credited has been\ + \ determined." enum: - estimation type: string @@ -593,21 +596,26 @@ components: additionalProperties: false properties: reason: - description: "Possible values:\n\n - **refusedForRegulatoryReasons**." + description: "The reason why the transfer failed Adyen's internal review.\ + \ \n\nPossible values:\n\n- **refusedForRegulatoryReasons**: the transfer\ + \ does not comply with Adyen's risk policy. For more information, [contact\ + \ the Support Team](https://www.adyen.help/hc/en-us/requests/new). " enum: - refusedForRegulatoryReasons type: string status: - description: "Possible values:\n\n - **pending**: Transfer is under internal\ - \ review.\n\n- **failed**: Transfer failed to pass internal review. See\ - \ field **reason** for details.\n\n" + description: "The status of the transfer.\n\nPossible values:\n\n - **pending**:\ + \ the transfer is under internal review.\n\n- **failed**: the transfer\ + \ failed Adyen's internal review. For details, see `reason`.\n\n" enum: - pending - failed type: string type: default: internalReview - description: '**internalReview**' + description: "The type of tracking event. \n\nPossible values: \n\n - **internalReview**:\ + \ the transfer was flagged because it does not comply with Adyen's risk\ + \ policy." enum: - internalReview type: string @@ -1397,7 +1405,7 @@ components: type: string tracking: x-addedInVersion: '3' - description: Most recent tracking information for the transfer. + description: The latest tracking information of the transfer. oneOf: - $ref: '#/components/schemas/ConfirmationTrackingData' - $ref: '#/components/schemas/EstimationTrackingData' @@ -1476,7 +1484,8 @@ components: x-addedInVersion: '3' deprecated: true x-deprecatedInVersion: '4' - x-deprecatedMessage: This will be removed in v5. Please use **trackingData.estimatedArrivalTime**. + 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 diff --git a/yaml/TransferService-v4.yaml b/yaml/TransferService-v4.yaml index 251b5005..87696017 100644 --- a/yaml/TransferService-v4.yaml +++ b/yaml/TransferService-v4.yaml @@ -1286,14 +1286,15 @@ components: additionalProperties: false properties: status: - description: "Possible values:\n\n - **credited**: Transfer is credited\ - \ to beneficiary." + description: "The status of the transfer.\n\nPossible values:\n\n - **credited**:\ + \ the funds are credited to your user's transfer instrument or bank account." enum: - credited type: string type: default: confirmation - description: '**confirmation**' + description: "The type of the tracking event.\n\nPossible values:\n\n -\ + \ **confirmation**: the transfer passed Adyen's internal review." enum: - confirmation type: string @@ -1383,7 +1384,9 @@ components: type: string type: default: estimation - description: '**estimation**' + description: "The type of tracking event. \n\nPossible values: \n\n- **estimation**:\ + \ the estimated date and time of when the funds will be credited has been\ + \ determined." enum: - estimation type: string @@ -1507,21 +1510,26 @@ components: additionalProperties: false properties: reason: - description: "Possible values:\n\n - **refusedForRegulatoryReasons**." + description: "The reason why the transfer failed Adyen's internal review.\ + \ \n\nPossible values:\n\n- **refusedForRegulatoryReasons**: the transfer\ + \ does not comply with Adyen's risk policy. For more information, [contact\ + \ the Support Team](https://www.adyen.help/hc/en-us/requests/new). " enum: - refusedForRegulatoryReasons type: string status: - description: "Possible values:\n\n - **pending**: Transfer is under internal\ - \ review.\n\n- **failed**: Transfer failed to pass internal review. See\ - \ field **reason** for details.\n\n" + description: "The status of the transfer.\n\nPossible values:\n\n - **pending**:\ + \ the transfer is under internal review.\n\n- **failed**: the transfer\ + \ failed Adyen's internal review. For details, see `reason`.\n\n" enum: - pending - failed type: string type: default: internalReview - description: '**internalReview**' + description: "The type of tracking event. \n\nPossible values: \n\n - **internalReview**:\ + \ the transfer was flagged because it does not comply with Adyen's risk\ + \ policy." enum: - internalReview type: string @@ -2814,7 +2822,7 @@ components: type: string tracking: x-addedInVersion: '3' - description: Most recent tracking information for the transfer. + description: The latest tracking information of the transfer. oneOf: - $ref: '#/components/schemas/ConfirmationTrackingData' - $ref: '#/components/schemas/EstimationTrackingData' @@ -2893,7 +2901,8 @@ components: x-addedInVersion: '3' deprecated: true x-deprecatedInVersion: '4' - x-deprecatedMessage: This will be removed in v5. Please use **trackingData.estimatedArrivalTime**. + 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