From 30118f88f9e8ad52c55b05f5a9af1c5a2dc78393 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Wed, 30 Oct 2024 00:35:43 +0100 Subject: [PATCH] spec release --- json/TransactionService-v1.json | 33 +++++++++++++--------- json/TransactionService-v2.json | 33 +++++++++++++--------- json/TransactionService-v3.json | 33 +++++++++++++--------- json/TransactionService-v4.json | 33 +++++++++++++--------- yaml/TransactionService-v1.yaml | 49 ++++++++++++++++++++++++--------- yaml/TransactionService-v2.yaml | 49 ++++++++++++++++++++++++--------- yaml/TransactionService-v3.yaml | 49 ++++++++++++++++++++++++--------- yaml/TransactionService-v4.yaml | 49 ++++++++++++++++++++++++--------- 8 files changed, 224 insertions(+), 104 deletions(-) diff --git a/json/TransactionService-v1.json b/json/TransactionService-v1.json index 16a24f86..923a7c61 100644 --- a/json/TransactionService-v1.json +++ b/json/TransactionService-v1.json @@ -1,25 +1,32 @@ { "openapi" : "3.1.0", + "servers" : [ { + "url" : "https://balanceplatform-api-live.adyen.com/btl/api/v1", + "description" : "Live Environment" + }, { + "url" : "https://balanceplatform-api-test.adyen.com/btl/api/v1", + "description" : "Test Environment" + } ], "info" : { - "title" : "Btl", - "description" : "OpenAPI spec for Btl", + "title" : "Raise disputes API", + "description" : "Disputes API for Issuing that you can use to raise disputes on transactions made with an Adyen-issued card. You can also add attachments as supporting information for a raised dispute, update information about the dispute, submit the dispute for a chargeback, or close the dispute.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Disputes API, you need an additional role for your API credential. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/api/v{version}/disputes\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/api/v{version}`.\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", "url" : "https://github.com/Adyen/adyen-openapi" }, "version" : "1", - "x-timestamp" : "2024-10-07T20:31:53Z" + "x-timestamp" : "2024-10-29T23:27:38Z" }, "tags" : [ { - "name" : "DisputeAttachmentResource" + "name" : "Dispute Attachments" }, { - "name" : "RaiseDisputeResource" + "name" : "Raise Disputes" } ], "paths" : { "/disputes/{disputeId}/attachments" : { "get" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Get all attachments linked to a raised dispute", "description" : "Get a list of attachments associated with a dispute ID.", "operationId" : "get-disputes-disputeId-attachments", @@ -50,7 +57,7 @@ "x-sortIndex" : 0 }, "post" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Add an attachment to a dispute", "description" : "Add supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the dispute.", "operationId" : "post-disputes-disputeId-attachments", @@ -90,7 +97,7 @@ }, "/disputes/{disputeId}/attachments/{attachmentId}" : { "get" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Get an attachment", "description" : "Search for a single attachment, providing the specific dispute ID and attachment ID.", "operationId" : "get-disputes-disputeId-attachments-attachmentId", @@ -126,7 +133,7 @@ "x-sortIndex" : 0 }, "delete" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Delete attachment from a dispute", "description" : "Removes the attachment from the raised dispute. Adyen may keep this file for compliance purposes.", "operationId" : "delete-disputes-disputeId-attachments-attachmentId", @@ -160,7 +167,7 @@ }, "/disputes" : { "get" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Get a list of raised disputes", "description" : "Returns a list of raised disputes that match the query parameters.\n\nThis endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.", "operationId" : "get-disputes", @@ -225,7 +232,7 @@ "x-sortIndex" : 0 }, "post" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Raise a dispute", "description" : "Raise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute.\n\nRaising a dispute returns a dispute ID, which you can use to update details about the dispute, provide supporting documentation, close the dispute, or submit the dispute for a chargeback. You can also use the dispute ID to view the status of the dispute.", "operationId" : "post-disputes", @@ -256,7 +263,7 @@ }, "/disputes/{id}" : { "get" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Get dispute by ID", "description" : "Get a raised dispute by ID.", "operationId" : "get-disputes-id", @@ -284,7 +291,7 @@ "x-sortIndex" : 0 }, "patch" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Update a raised dispute", "description" : "Update information related to a raised dispute, or change a dispute's status from **draft** to **submitted** or **closed**.\n\n**Note:** Changing the status of a dispute to **submitted** or **closed** is a final action. You cannot make updates to a **submitted** or **closed** dispute. Make sure to upload all supporting attachments using the `POST /disputes/{id}/attachments` endpoint before you submit a dispute. When you update a dispute to **submitted**, Adyen sends the raised dispute to the card scheme for review and acquirer defense. When you update a raised dispute to **closed**, Adyen closes the dispute, and the dispute is no longer eligible for review by the card scheme.", "operationId" : "patch-disputes-id", diff --git a/json/TransactionService-v2.json b/json/TransactionService-v2.json index 4c316b0f..92848114 100644 --- a/json/TransactionService-v2.json +++ b/json/TransactionService-v2.json @@ -1,25 +1,32 @@ { "openapi" : "3.1.0", + "servers" : [ { + "url" : "https://balanceplatform-api-live.adyen.com/btl/api/v2", + "description" : "Live Environment" + }, { + "url" : "https://balanceplatform-api-test.adyen.com/btl/api/v2", + "description" : "Test Environment" + } ], "info" : { - "title" : "Btl", - "description" : "OpenAPI spec for Btl", + "title" : "Raise disputes API", + "description" : "Disputes API for Issuing that you can use to raise disputes on transactions made with an Adyen-issued card. You can also add attachments as supporting information for a raised dispute, update information about the dispute, submit the dispute for a chargeback, or close the dispute.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Disputes API, you need an additional role for your API credential. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/api/v{version}/disputes\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/api/v{version}`.\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", "url" : "https://github.com/Adyen/adyen-openapi" }, "version" : "2", - "x-timestamp" : "2024-10-07T20:31:54Z" + "x-timestamp" : "2024-10-29T23:27:38Z" }, "tags" : [ { - "name" : "DisputeAttachmentResource" + "name" : "Dispute Attachments" }, { - "name" : "RaiseDisputeResource" + "name" : "Raise Disputes" } ], "paths" : { "/disputes/{disputeId}/attachments" : { "get" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Get all attachments linked to a raised dispute", "description" : "Get a list of attachments associated with a dispute ID.", "operationId" : "get-disputes-disputeId-attachments", @@ -50,7 +57,7 @@ "x-sortIndex" : 0 }, "post" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Add an attachment to a dispute", "description" : "Add supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the dispute.", "operationId" : "post-disputes-disputeId-attachments", @@ -90,7 +97,7 @@ }, "/disputes/{disputeId}/attachments/{attachmentId}" : { "get" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Get an attachment", "description" : "Search for a single attachment, providing the specific dispute ID and attachment ID.", "operationId" : "get-disputes-disputeId-attachments-attachmentId", @@ -126,7 +133,7 @@ "x-sortIndex" : 0 }, "delete" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Delete attachment from a dispute", "description" : "Removes the attachment from the raised dispute. Adyen may keep this file for compliance purposes.", "operationId" : "delete-disputes-disputeId-attachments-attachmentId", @@ -160,7 +167,7 @@ }, "/disputes" : { "get" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Get a list of raised disputes", "description" : "Returns a list of raised disputes that match the query parameters.\n\nThis endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.", "operationId" : "get-disputes", @@ -225,7 +232,7 @@ "x-sortIndex" : 0 }, "post" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Raise a dispute", "description" : "Raise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute.\n\nRaising a dispute returns a dispute ID, which you can use to update details about the dispute, provide supporting documentation, close the dispute, or submit the dispute for a chargeback. You can also use the dispute ID to view the status of the dispute.", "operationId" : "post-disputes", @@ -256,7 +263,7 @@ }, "/disputes/{id}" : { "get" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Get dispute by ID", "description" : "Get a raised dispute by ID.", "operationId" : "get-disputes-id", @@ -284,7 +291,7 @@ "x-sortIndex" : 0 }, "patch" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Update a raised dispute", "description" : "Update information related to a raised dispute, or change a dispute's status from **draft** to **submitted** or **closed**.\n\n**Note:** Changing the status of a dispute to **submitted** or **closed** is a final action. You cannot make updates to a **submitted** or **closed** dispute. Make sure to upload all supporting attachments using the `POST /disputes/{id}/attachments` endpoint before you submit a dispute. When you update a dispute to **submitted**, Adyen sends the raised dispute to the card scheme for review and acquirer defense. When you update a raised dispute to **closed**, Adyen closes the dispute, and the dispute is no longer eligible for review by the card scheme.", "operationId" : "patch-disputes-id", diff --git a/json/TransactionService-v3.json b/json/TransactionService-v3.json index 276951bf..70970553 100644 --- a/json/TransactionService-v3.json +++ b/json/TransactionService-v3.json @@ -1,25 +1,32 @@ { "openapi" : "3.1.0", + "servers" : [ { + "url" : "https://balanceplatform-api-live.adyen.com/btl/api/v3", + "description" : "Live Environment" + }, { + "url" : "https://balanceplatform-api-test.adyen.com/btl/api/v3", + "description" : "Test Environment" + } ], "info" : { - "title" : "Btl", - "description" : "OpenAPI spec for Btl", + "title" : "Raise disputes API", + "description" : "Disputes API for Issuing that you can use to raise disputes on transactions made with an Adyen-issued card. You can also add attachments as supporting information for a raised dispute, update information about the dispute, submit the dispute for a chargeback, or close the dispute.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Disputes API, you need an additional role for your API credential. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/api/v{version}/disputes\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/api/v{version}`.\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", "url" : "https://github.com/Adyen/adyen-openapi" }, "version" : "3", - "x-timestamp" : "2024-10-07T20:31:54Z" + "x-timestamp" : "2024-10-29T23:27:38Z" }, "tags" : [ { - "name" : "DisputeAttachmentResource" + "name" : "Dispute Attachments" }, { - "name" : "RaiseDisputeResource" + "name" : "Raise Disputes" } ], "paths" : { "/disputes/{disputeId}/attachments" : { "get" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Get all attachments linked to a raised dispute", "description" : "Get a list of attachments associated with a dispute ID.", "operationId" : "get-disputes-disputeId-attachments", @@ -50,7 +57,7 @@ "x-sortIndex" : 0 }, "post" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Add an attachment to a dispute", "description" : "Add supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the dispute.", "operationId" : "post-disputes-disputeId-attachments", @@ -90,7 +97,7 @@ }, "/disputes/{disputeId}/attachments/{attachmentId}" : { "get" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Get an attachment", "description" : "Search for a single attachment, providing the specific dispute ID and attachment ID.", "operationId" : "get-disputes-disputeId-attachments-attachmentId", @@ -126,7 +133,7 @@ "x-sortIndex" : 0 }, "delete" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Delete attachment from a dispute", "description" : "Removes the attachment from the raised dispute. Adyen may keep this file for compliance purposes.", "operationId" : "delete-disputes-disputeId-attachments-attachmentId", @@ -160,7 +167,7 @@ }, "/disputes" : { "get" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Get a list of raised disputes", "description" : "Returns a list of raised disputes that match the query parameters.\n\nThis endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.", "operationId" : "get-disputes", @@ -225,7 +232,7 @@ "x-sortIndex" : 0 }, "post" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Raise a dispute", "description" : "Raise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute.\n\nRaising a dispute returns a dispute ID, which you can use to update details about the dispute, provide supporting documentation, close the dispute, or submit the dispute for a chargeback. You can also use the dispute ID to view the status of the dispute.", "operationId" : "post-disputes", @@ -256,7 +263,7 @@ }, "/disputes/{id}" : { "get" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Get dispute by ID", "description" : "Get a raised dispute by ID.", "operationId" : "get-disputes-id", @@ -284,7 +291,7 @@ "x-sortIndex" : 0 }, "patch" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Update a raised dispute", "description" : "Update information related to a raised dispute, or change a dispute's status from **draft** to **submitted** or **closed**.\n\n**Note:** Changing the status of a dispute to **submitted** or **closed** is a final action. You cannot make updates to a **submitted** or **closed** dispute. Make sure to upload all supporting attachments using the `POST /disputes/{id}/attachments` endpoint before you submit a dispute. When you update a dispute to **submitted**, Adyen sends the raised dispute to the card scheme for review and acquirer defense. When you update a raised dispute to **closed**, Adyen closes the dispute, and the dispute is no longer eligible for review by the card scheme.", "operationId" : "patch-disputes-id", diff --git a/json/TransactionService-v4.json b/json/TransactionService-v4.json index 1ab7294a..8bf7ae2c 100644 --- a/json/TransactionService-v4.json +++ b/json/TransactionService-v4.json @@ -1,25 +1,32 @@ { "openapi" : "3.1.0", + "servers" : [ { + "url" : "https://balanceplatform-api-live.adyen.com/btl/api/v4", + "description" : "Live Environment" + }, { + "url" : "https://balanceplatform-api-test.adyen.com/btl/api/v4", + "description" : "Test Environment" + } ], "info" : { - "title" : "Btl", - "description" : "OpenAPI spec for Btl", + "title" : "Raise disputes API", + "description" : "Disputes API for Issuing that you can use to raise disputes on transactions made with an Adyen-issued card. You can also add attachments as supporting information for a raised dispute, update information about the dispute, submit the dispute for a chargeback, or close the dispute.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Disputes API, you need an additional role for your API credential. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/api/v{version}/disputes\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/api/v{version}`.\n\n", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", "url" : "https://github.com/Adyen/adyen-openapi" }, "version" : "4", - "x-timestamp" : "2024-10-07T20:31:54Z" + "x-timestamp" : "2024-10-29T23:27:38Z" }, "tags" : [ { - "name" : "DisputeAttachmentResource" + "name" : "Dispute Attachments" }, { - "name" : "RaiseDisputeResource" + "name" : "Raise Disputes" } ], "paths" : { "/disputes/{disputeId}/attachments" : { "get" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Get all attachments linked to a raised dispute", "description" : "Get a list of attachments associated with a dispute ID.", "operationId" : "get-disputes-disputeId-attachments", @@ -50,7 +57,7 @@ "x-sortIndex" : 0 }, "post" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Add an attachment to a dispute", "description" : "Add supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the dispute.", "operationId" : "post-disputes-disputeId-attachments", @@ -90,7 +97,7 @@ }, "/disputes/{disputeId}/attachments/{attachmentId}" : { "get" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Get an attachment", "description" : "Search for a single attachment, providing the specific dispute ID and attachment ID.", "operationId" : "get-disputes-disputeId-attachments-attachmentId", @@ -126,7 +133,7 @@ "x-sortIndex" : 0 }, "delete" : { - "tags" : [ "DisputeAttachmentResource" ], + "tags" : [ "Dispute Attachments" ], "summary" : "Delete attachment from a dispute", "description" : "Removes the attachment from the raised dispute. Adyen may keep this file for compliance purposes.", "operationId" : "delete-disputes-disputeId-attachments-attachmentId", @@ -160,7 +167,7 @@ }, "/disputes" : { "get" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Get a list of raised disputes", "description" : "Returns a list of raised disputes that match the query parameters.\n\nThis endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.", "operationId" : "get-disputes", @@ -225,7 +232,7 @@ "x-sortIndex" : 0 }, "post" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Raise a dispute", "description" : "Raise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute.\n\nRaising a dispute returns a dispute ID, which you can use to update details about the dispute, provide supporting documentation, close the dispute, or submit the dispute for a chargeback. You can also use the dispute ID to view the status of the dispute.", "operationId" : "post-disputes", @@ -256,7 +263,7 @@ }, "/disputes/{id}" : { "get" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Get dispute by ID", "description" : "Get a raised dispute by ID.", "operationId" : "get-disputes-id", @@ -284,7 +291,7 @@ "x-sortIndex" : 0 }, "patch" : { - "tags" : [ "RaiseDisputeResource" ], + "tags" : [ "Raise Disputes" ], "summary" : "Update a raised dispute", "description" : "Update information related to a raised dispute, or change a dispute's status from **draft** to **submitted** or **closed**.\n\n**Note:** Changing the status of a dispute to **submitted** or **closed** is a final action. You cannot make updates to a **submitted** or **closed** dispute. Make sure to upload all supporting attachments using the `POST /disputes/{id}/attachments` endpoint before you submit a dispute. When you update a dispute to **submitted**, Adyen sends the raised dispute to the card scheme for review and acquirer defense. When you update a raised dispute to **closed**, Adyen closes the dispute, and the dispute is no longer eligible for review by the card scheme.", "operationId" : "patch-disputes-id", diff --git a/yaml/TransactionService-v1.yaml b/yaml/TransactionService-v1.yaml index 1ab4f8a4..8e442993 100644 --- a/yaml/TransactionService-v1.yaml +++ b/yaml/TransactionService-v1.yaml @@ -1,21 +1,44 @@ openapi: 3.1.0 +servers: +- url: https://balanceplatform-api-live.adyen.com/btl/api/v1 + description: Live Environment +- url: https://balanceplatform-api-test.adyen.com/btl/api/v1 + description: Test Environment info: - title: Btl - description: OpenAPI spec for Btl + title: Raise disputes API + description: "Disputes API for Issuing that you can use to raise disputes on transactions\ + \ made with an Adyen-issued card. You can also add attachments as supporting information\ + \ for a raised dispute, update information about the dispute, submit the dispute\ + \ for a chargeback, or close the dispute.\n\n## Authentication\nYour Adyen contact\ + \ will provide your API credential and an API key. To connect to the API, add\ + \ an `X-API-Key` header with the API key as the value, for example:\n\n ```\n\ + curl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\"\ + \ \\\n...\n```\n\nAlternatively, you can use the username and password to connect\ + \ to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type:\ + \ application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\"\ + \ \\\n...\n```\n## Roles and permissions\nTo use the Disputes API, you need an\ + \ additional role for your API credential. Your Adyen contact will set up the\ + \ roles and permissions for you.\n## Versioning\nThe Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ + \ using a version suffix in the endpoint URL. This suffix has the following format:\ + \ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/api/v{version}/disputes\n\ + ```\n## Going live\nWhen going live, your Adyen contact will provide your API\ + \ credential for the live environment. You can then use the username and password\ + \ to send requests to `https://balanceplatform-api-live.adyen.com/btl/api/v{version}`.\n\ + \n" termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi version: '1' - x-timestamp: '2024-10-07T20:31:53Z' + x-timestamp: '2024-10-29T23:27:38Z' tags: -- name: DisputeAttachmentResource -- name: RaiseDisputeResource +- name: Dispute Attachments +- name: Raise Disputes paths: /disputes/{disputeId}/attachments: get: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Get all attachments linked to a raised dispute description: Get a list of attachments associated with a dispute ID. operationId: get-disputes-disputeId-attachments @@ -38,7 +61,7 @@ paths: x-sortIndex: 0 post: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Add an attachment to a dispute description: Add supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the @@ -68,7 +91,7 @@ paths: /disputes/{disputeId}/attachments/{attachmentId}: get: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Get an attachment description: Search for a single attachment, providing the specific dispute ID and attachment ID. @@ -96,7 +119,7 @@ paths: x-sortIndex: 0 delete: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Delete attachment from a dispute description: Removes the attachment from the raised dispute. Adyen may keep this file for compliance purposes. @@ -124,7 +147,7 @@ paths: /disputes: get: tags: - - RaiseDisputeResource + - Raise Disputes summary: Get a list of raised disputes description: 'Returns a list of raised disputes that match the query parameters. @@ -186,7 +209,7 @@ paths: x-sortIndex: 0 post: tags: - - RaiseDisputeResource + - Raise Disputes summary: Raise a dispute description: 'Raise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute. @@ -214,7 +237,7 @@ paths: /disputes/{id}: get: tags: - - RaiseDisputeResource + - Raise Disputes summary: Get dispute by ID description: Get a raised dispute by ID. operationId: get-disputes-id @@ -235,7 +258,7 @@ paths: x-sortIndex: 0 patch: tags: - - RaiseDisputeResource + - Raise Disputes summary: Update a raised dispute description: 'Update information related to a raised dispute, or change a dispute''s status from **draft** to **submitted** or **closed**. diff --git a/yaml/TransactionService-v2.yaml b/yaml/TransactionService-v2.yaml index d098afda..cb9bf906 100644 --- a/yaml/TransactionService-v2.yaml +++ b/yaml/TransactionService-v2.yaml @@ -1,21 +1,44 @@ openapi: 3.1.0 +servers: +- url: https://balanceplatform-api-live.adyen.com/btl/api/v2 + description: Live Environment +- url: https://balanceplatform-api-test.adyen.com/btl/api/v2 + description: Test Environment info: - title: Btl - description: OpenAPI spec for Btl + title: Raise disputes API + description: "Disputes API for Issuing that you can use to raise disputes on transactions\ + \ made with an Adyen-issued card. You can also add attachments as supporting information\ + \ for a raised dispute, update information about the dispute, submit the dispute\ + \ for a chargeback, or close the dispute.\n\n## Authentication\nYour Adyen contact\ + \ will provide your API credential and an API key. To connect to the API, add\ + \ an `X-API-Key` header with the API key as the value, for example:\n\n ```\n\ + curl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\"\ + \ \\\n...\n```\n\nAlternatively, you can use the username and password to connect\ + \ to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type:\ + \ application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\"\ + \ \\\n...\n```\n## Roles and permissions\nTo use the Disputes API, you need an\ + \ additional role for your API credential. Your Adyen contact will set up the\ + \ roles and permissions for you.\n## Versioning\nThe Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ + \ using a version suffix in the endpoint URL. This suffix has the following format:\ + \ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/api/v{version}/disputes\n\ + ```\n## Going live\nWhen going live, your Adyen contact will provide your API\ + \ credential for the live environment. You can then use the username and password\ + \ to send requests to `https://balanceplatform-api-live.adyen.com/btl/api/v{version}`.\n\ + \n" termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi version: '2' - x-timestamp: '2024-10-07T20:31:54Z' + x-timestamp: '2024-10-29T23:27:38Z' tags: -- name: DisputeAttachmentResource -- name: RaiseDisputeResource +- name: Dispute Attachments +- name: Raise Disputes paths: /disputes/{disputeId}/attachments: get: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Get all attachments linked to a raised dispute description: Get a list of attachments associated with a dispute ID. operationId: get-disputes-disputeId-attachments @@ -38,7 +61,7 @@ paths: x-sortIndex: 0 post: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Add an attachment to a dispute description: Add supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the @@ -68,7 +91,7 @@ paths: /disputes/{disputeId}/attachments/{attachmentId}: get: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Get an attachment description: Search for a single attachment, providing the specific dispute ID and attachment ID. @@ -96,7 +119,7 @@ paths: x-sortIndex: 0 delete: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Delete attachment from a dispute description: Removes the attachment from the raised dispute. Adyen may keep this file for compliance purposes. @@ -124,7 +147,7 @@ paths: /disputes: get: tags: - - RaiseDisputeResource + - Raise Disputes summary: Get a list of raised disputes description: 'Returns a list of raised disputes that match the query parameters. @@ -186,7 +209,7 @@ paths: x-sortIndex: 0 post: tags: - - RaiseDisputeResource + - Raise Disputes summary: Raise a dispute description: 'Raise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute. @@ -214,7 +237,7 @@ paths: /disputes/{id}: get: tags: - - RaiseDisputeResource + - Raise Disputes summary: Get dispute by ID description: Get a raised dispute by ID. operationId: get-disputes-id @@ -235,7 +258,7 @@ paths: x-sortIndex: 0 patch: tags: - - RaiseDisputeResource + - Raise Disputes summary: Update a raised dispute description: 'Update information related to a raised dispute, or change a dispute''s status from **draft** to **submitted** or **closed**. diff --git a/yaml/TransactionService-v3.yaml b/yaml/TransactionService-v3.yaml index 4ae08adf..f673b212 100644 --- a/yaml/TransactionService-v3.yaml +++ b/yaml/TransactionService-v3.yaml @@ -1,21 +1,44 @@ openapi: 3.1.0 +servers: +- url: https://balanceplatform-api-live.adyen.com/btl/api/v3 + description: Live Environment +- url: https://balanceplatform-api-test.adyen.com/btl/api/v3 + description: Test Environment info: - title: Btl - description: OpenAPI spec for Btl + title: Raise disputes API + description: "Disputes API for Issuing that you can use to raise disputes on transactions\ + \ made with an Adyen-issued card. You can also add attachments as supporting information\ + \ for a raised dispute, update information about the dispute, submit the dispute\ + \ for a chargeback, or close the dispute.\n\n## Authentication\nYour Adyen contact\ + \ will provide your API credential and an API key. To connect to the API, add\ + \ an `X-API-Key` header with the API key as the value, for example:\n\n ```\n\ + curl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\"\ + \ \\\n...\n```\n\nAlternatively, you can use the username and password to connect\ + \ to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type:\ + \ application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\"\ + \ \\\n...\n```\n## Roles and permissions\nTo use the Disputes API, you need an\ + \ additional role for your API credential. Your Adyen contact will set up the\ + \ roles and permissions for you.\n## Versioning\nThe Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ + \ using a version suffix in the endpoint URL. This suffix has the following format:\ + \ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/api/v{version}/disputes\n\ + ```\n## Going live\nWhen going live, your Adyen contact will provide your API\ + \ credential for the live environment. You can then use the username and password\ + \ to send requests to `https://balanceplatform-api-live.adyen.com/btl/api/v{version}`.\n\ + \n" termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi version: '3' - x-timestamp: '2024-10-07T20:31:54Z' + x-timestamp: '2024-10-29T23:27:38Z' tags: -- name: DisputeAttachmentResource -- name: RaiseDisputeResource +- name: Dispute Attachments +- name: Raise Disputes paths: /disputes/{disputeId}/attachments: get: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Get all attachments linked to a raised dispute description: Get a list of attachments associated with a dispute ID. operationId: get-disputes-disputeId-attachments @@ -38,7 +61,7 @@ paths: x-sortIndex: 0 post: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Add an attachment to a dispute description: Add supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the @@ -68,7 +91,7 @@ paths: /disputes/{disputeId}/attachments/{attachmentId}: get: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Get an attachment description: Search for a single attachment, providing the specific dispute ID and attachment ID. @@ -96,7 +119,7 @@ paths: x-sortIndex: 0 delete: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Delete attachment from a dispute description: Removes the attachment from the raised dispute. Adyen may keep this file for compliance purposes. @@ -124,7 +147,7 @@ paths: /disputes: get: tags: - - RaiseDisputeResource + - Raise Disputes summary: Get a list of raised disputes description: 'Returns a list of raised disputes that match the query parameters. @@ -186,7 +209,7 @@ paths: x-sortIndex: 0 post: tags: - - RaiseDisputeResource + - Raise Disputes summary: Raise a dispute description: 'Raise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute. @@ -214,7 +237,7 @@ paths: /disputes/{id}: get: tags: - - RaiseDisputeResource + - Raise Disputes summary: Get dispute by ID description: Get a raised dispute by ID. operationId: get-disputes-id @@ -235,7 +258,7 @@ paths: x-sortIndex: 0 patch: tags: - - RaiseDisputeResource + - Raise Disputes summary: Update a raised dispute description: 'Update information related to a raised dispute, or change a dispute''s status from **draft** to **submitted** or **closed**. diff --git a/yaml/TransactionService-v4.yaml b/yaml/TransactionService-v4.yaml index 532e2756..e02c6c37 100644 --- a/yaml/TransactionService-v4.yaml +++ b/yaml/TransactionService-v4.yaml @@ -1,21 +1,44 @@ openapi: 3.1.0 +servers: +- url: https://balanceplatform-api-live.adyen.com/btl/api/v4 + description: Live Environment +- url: https://balanceplatform-api-test.adyen.com/btl/api/v4 + description: Test Environment info: - title: Btl - description: OpenAPI spec for Btl + title: Raise disputes API + description: "Disputes API for Issuing that you can use to raise disputes on transactions\ + \ made with an Adyen-issued card. You can also add attachments as supporting information\ + \ for a raised dispute, update information about the dispute, submit the dispute\ + \ for a chargeback, or close the dispute.\n\n## Authentication\nYour Adyen contact\ + \ will provide your API credential and an API key. To connect to the API, add\ + \ an `X-API-Key` header with the API key as the value, for example:\n\n ```\n\ + curl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\"\ + \ \\\n...\n```\n\nAlternatively, you can use the username and password to connect\ + \ to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type:\ + \ application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\"\ + \ \\\n...\n```\n## Roles and permissions\nTo use the Disputes API, you need an\ + \ additional role for your API credential. Your Adyen contact will set up the\ + \ roles and permissions for you.\n## Versioning\nThe Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ + \ using a version suffix in the endpoint URL. This suffix has the following format:\ + \ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/api/v{version}/disputes\n\ + ```\n## Going live\nWhen going live, your Adyen contact will provide your API\ + \ credential for the live environment. You can then use the username and password\ + \ to send requests to `https://balanceplatform-api-live.adyen.com/btl/api/v{version}`.\n\ + \n" termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi version: '4' - x-timestamp: '2024-10-07T20:31:54Z' + x-timestamp: '2024-10-29T23:27:38Z' tags: -- name: DisputeAttachmentResource -- name: RaiseDisputeResource +- name: Dispute Attachments +- name: Raise Disputes paths: /disputes/{disputeId}/attachments: get: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Get all attachments linked to a raised dispute description: Get a list of attachments associated with a dispute ID. operationId: get-disputes-disputeId-attachments @@ -38,7 +61,7 @@ paths: x-sortIndex: 0 post: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Add an attachment to a dispute description: Add supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the @@ -68,7 +91,7 @@ paths: /disputes/{disputeId}/attachments/{attachmentId}: get: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Get an attachment description: Search for a single attachment, providing the specific dispute ID and attachment ID. @@ -96,7 +119,7 @@ paths: x-sortIndex: 0 delete: tags: - - DisputeAttachmentResource + - Dispute Attachments summary: Delete attachment from a dispute description: Removes the attachment from the raised dispute. Adyen may keep this file for compliance purposes. @@ -124,7 +147,7 @@ paths: /disputes: get: tags: - - RaiseDisputeResource + - Raise Disputes summary: Get a list of raised disputes description: 'Returns a list of raised disputes that match the query parameters. @@ -186,7 +209,7 @@ paths: x-sortIndex: 0 post: tags: - - RaiseDisputeResource + - Raise Disputes summary: Raise a dispute description: 'Raise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute. @@ -214,7 +237,7 @@ paths: /disputes/{id}: get: tags: - - RaiseDisputeResource + - Raise Disputes summary: Get dispute by ID description: Get a raised dispute by ID. operationId: get-disputes-id @@ -235,7 +258,7 @@ paths: x-sortIndex: 0 patch: tags: - - RaiseDisputeResource + - Raise Disputes summary: Update a raised dispute description: 'Update information related to a raised dispute, or change a dispute''s status from **draft** to **submitted** or **closed**.