mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
spec release
This commit is contained in:
Adyen Automation
@@ -13,21 +13,21 @@
|
||||
},
|
||||
"tags" : [
|
||||
{
|
||||
"name" : "Dispute/Chargeback"
|
||||
"name" : "General"
|
||||
}
|
||||
],
|
||||
"webhooks" : {
|
||||
"balancePlatform.dispute.created" : {
|
||||
"post" : {
|
||||
"tags" : [
|
||||
"Dispute/Chargeback"
|
||||
"General"
|
||||
],
|
||||
"summary" : "Dispute is created",
|
||||
"summary" : "Dispute created",
|
||||
"description" : "Adyen sends this webhook when a dispute is created. This webhook only informs your server of requests. ",
|
||||
"x-addedInVersion" : "1",
|
||||
"operationId" : "post-balancePlatform.dispute.created",
|
||||
"x-sortIndex" : 1,
|
||||
"x-methodName" : "disputeIsCreated",
|
||||
"x-methodName" : "disputeCreated",
|
||||
"security" : [
|
||||
{
|
||||
"BasicAuth" : [
|
||||
@@ -60,14 +60,14 @@
|
||||
"balancePlatform.dispute.updated" : {
|
||||
"post" : {
|
||||
"tags" : [
|
||||
"Dispute/Chargeback"
|
||||
"General"
|
||||
],
|
||||
"summary" : "Dispute is updated",
|
||||
"summary" : "Dispute updated",
|
||||
"description" : "Adyen sends this webhook when a dispute is updated. This webhook only informs your server of requests. ",
|
||||
"x-addedInVersion" : "1",
|
||||
"operationId" : "post-balancePlatform.dispute.updated",
|
||||
"x-sortIndex" : 1,
|
||||
"x-methodName" : "disputeIsUpdated",
|
||||
"x-methodName" : "disputeUpdated",
|
||||
"security" : [
|
||||
{
|
||||
"BasicAuth" : [
|
||||
@@ -159,21 +159,25 @@
|
||||
"description" : "The ID of the resource.",
|
||||
"type" : "string"
|
||||
},
|
||||
"reason" : {
|
||||
"description" : "The reason for which you dispute the transaction.",
|
||||
"enum" : [
|
||||
"fraud",
|
||||
"notDelivered"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The current status of the dispute.",
|
||||
"type" : "string"
|
||||
},
|
||||
"statusDetail" : {
|
||||
"description" : "Additional information about the status of the dispute, when available.",
|
||||
"type" : "string"
|
||||
},
|
||||
"transactionId" : {
|
||||
"description" : "The unique reference of the transaction for which the dispute is requested.",
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "The type of dispute raised for the transaction.",
|
||||
"enum" : [
|
||||
"fraud",
|
||||
"notDelivered"
|
||||
],
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
"url" : "https://github.com/Adyen/adyen-openapi"
|
||||
},
|
||||
"version" : "1",
|
||||
"x-timestamp" : "2024-10-29T23:27:38Z"
|
||||
"x-timestamp" : "2024-11-04T21:26:21Z"
|
||||
},
|
||||
"tags" : [ {
|
||||
"name" : "Dispute Attachments"
|
||||
@@ -54,7 +54,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
},
|
||||
"post" : {
|
||||
"tags" : [ "Dispute Attachments" ],
|
||||
@@ -92,7 +92,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
}
|
||||
},
|
||||
"/disputes/{disputeId}/attachments/{attachmentId}" : {
|
||||
@@ -130,7 +130,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
},
|
||||
"delete" : {
|
||||
"tags" : [ "Dispute Attachments" ],
|
||||
@@ -162,7 +162,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
}
|
||||
},
|
||||
"/disputes" : {
|
||||
@@ -222,14 +222,14 @@
|
||||
"schema" : {
|
||||
"type" : "array",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
},
|
||||
"post" : {
|
||||
"tags" : [ "Raise Disputes" ],
|
||||
@@ -240,7 +240,7 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -252,13 +252,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
}
|
||||
},
|
||||
"/disputes/{id}" : {
|
||||
@@ -282,13 +282,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
},
|
||||
"patch" : {
|
||||
"tags" : [ "Raise Disputes" ],
|
||||
@@ -308,7 +308,7 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/PatchableDisputeDTO"
|
||||
"$ref" : "#/components/schemas/PatchableDisputeRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -319,13 +319,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -390,15 +390,10 @@
|
||||
"type" : "string",
|
||||
"enum" : [ "merchant", "cardholder" ]
|
||||
},
|
||||
"DisputeDTO" : {
|
||||
"DisputeRequest" : {
|
||||
"required" : [ "transactionId", "type" ],
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"arn" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the `arn` to trace the transaction through its lifecycle.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"description" : {
|
||||
"type" : "string",
|
||||
"description" : "Your description for the dispute."
|
||||
@@ -411,11 +406,6 @@
|
||||
"description" : "Additional information for raising a dispute of `type` **fraud**. Required for disputes of `type` **fraud**.",
|
||||
"$ref" : "#/components/schemas/FraudInfo"
|
||||
},
|
||||
"id" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique identifier of the raised dispute.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"notDeliveredInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **notDelivered**. Required for disputes of `type` **notDelivered**.",
|
||||
"$ref" : "#/components/schemas/NotDeliveredInfo"
|
||||
@@ -496,7 +486,51 @@
|
||||
"type" : "string",
|
||||
"enum" : [ "goods", "services" ]
|
||||
},
|
||||
"PatchableDisputeDTO" : {
|
||||
"DisputeResponse" : {
|
||||
"required" : [ "transactionId", "type" ],
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"arn" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the `arn` to trace the transaction through its lifecycle.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"description" : {
|
||||
"type" : "string",
|
||||
"description" : "Your description for the dispute."
|
||||
},
|
||||
"disputedAmount" : {
|
||||
"description" : "The amount for which you dispute the transaction. The disputed amount cannot be greater than the transaction amount. If you do not provide an amount, the entire transaction amount will be disputed.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"fraudInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **fraud**. Required for disputes of `type` **fraud**.",
|
||||
"$ref" : "#/components/schemas/FraudInfo"
|
||||
},
|
||||
"id" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique identifier of the raised dispute.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"notDeliveredInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **notDelivered**. Required for disputes of `type` **notDelivered**.",
|
||||
"$ref" : "#/components/schemas/NotDeliveredInfo"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The current status of the dispute.\n\nYou can update a dispute to **submitted** or **closed**.\n\nPossible values: **draft**, **submitted**, **closed**, **won**, **chargeback**, **secondPresentment**.",
|
||||
"$ref" : "#/components/schemas/DisputeStatus"
|
||||
},
|
||||
"transactionId" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique reference of the transaction for which you are raising the dispute."
|
||||
},
|
||||
"type" : {
|
||||
"description" : "The type of the dispute.\n\nPossible values: **notDelivered**, **fraud**.",
|
||||
"$ref" : "#/components/schemas/DisputeType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PatchableDisputeRequest" : {
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"fraudInfo" : {
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
"url" : "https://github.com/Adyen/adyen-openapi"
|
||||
},
|
||||
"version" : "2",
|
||||
"x-timestamp" : "2024-10-29T23:27:38Z"
|
||||
"x-timestamp" : "2024-11-04T21:26:21Z"
|
||||
},
|
||||
"tags" : [ {
|
||||
"name" : "Dispute Attachments"
|
||||
@@ -54,7 +54,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
},
|
||||
"post" : {
|
||||
"tags" : [ "Dispute Attachments" ],
|
||||
@@ -92,7 +92,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
}
|
||||
},
|
||||
"/disputes/{disputeId}/attachments/{attachmentId}" : {
|
||||
@@ -130,7 +130,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
},
|
||||
"delete" : {
|
||||
"tags" : [ "Dispute Attachments" ],
|
||||
@@ -162,7 +162,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
}
|
||||
},
|
||||
"/disputes" : {
|
||||
@@ -222,14 +222,14 @@
|
||||
"schema" : {
|
||||
"type" : "array",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
},
|
||||
"post" : {
|
||||
"tags" : [ "Raise Disputes" ],
|
||||
@@ -240,7 +240,7 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -252,13 +252,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
}
|
||||
},
|
||||
"/disputes/{id}" : {
|
||||
@@ -282,13 +282,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
},
|
||||
"patch" : {
|
||||
"tags" : [ "Raise Disputes" ],
|
||||
@@ -308,7 +308,7 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/PatchableDisputeDTO"
|
||||
"$ref" : "#/components/schemas/PatchableDisputeRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -319,13 +319,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -390,15 +390,10 @@
|
||||
"type" : "string",
|
||||
"enum" : [ "merchant", "cardholder" ]
|
||||
},
|
||||
"DisputeDTO" : {
|
||||
"DisputeRequest" : {
|
||||
"required" : [ "transactionId", "type" ],
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"arn" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the `arn` to trace the transaction through its lifecycle.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"description" : {
|
||||
"type" : "string",
|
||||
"description" : "Your description for the dispute."
|
||||
@@ -411,11 +406,6 @@
|
||||
"description" : "Additional information for raising a dispute of `type` **fraud**. Required for disputes of `type` **fraud**.",
|
||||
"$ref" : "#/components/schemas/FraudInfo"
|
||||
},
|
||||
"id" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique identifier of the raised dispute.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"notDeliveredInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **notDelivered**. Required for disputes of `type` **notDelivered**.",
|
||||
"$ref" : "#/components/schemas/NotDeliveredInfo"
|
||||
@@ -496,7 +486,51 @@
|
||||
"type" : "string",
|
||||
"enum" : [ "goods", "services" ]
|
||||
},
|
||||
"PatchableDisputeDTO" : {
|
||||
"DisputeResponse" : {
|
||||
"required" : [ "transactionId", "type" ],
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"arn" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the `arn` to trace the transaction through its lifecycle.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"description" : {
|
||||
"type" : "string",
|
||||
"description" : "Your description for the dispute."
|
||||
},
|
||||
"disputedAmount" : {
|
||||
"description" : "The amount for which you dispute the transaction. The disputed amount cannot be greater than the transaction amount. If you do not provide an amount, the entire transaction amount will be disputed.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"fraudInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **fraud**. Required for disputes of `type` **fraud**.",
|
||||
"$ref" : "#/components/schemas/FraudInfo"
|
||||
},
|
||||
"id" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique identifier of the raised dispute.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"notDeliveredInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **notDelivered**. Required for disputes of `type` **notDelivered**.",
|
||||
"$ref" : "#/components/schemas/NotDeliveredInfo"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The current status of the dispute.\n\nYou can update a dispute to **submitted** or **closed**.\n\nPossible values: **draft**, **submitted**, **closed**, **won**, **chargeback**, **secondPresentment**.",
|
||||
"$ref" : "#/components/schemas/DisputeStatus"
|
||||
},
|
||||
"transactionId" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique reference of the transaction for which you are raising the dispute."
|
||||
},
|
||||
"type" : {
|
||||
"description" : "The type of the dispute.\n\nPossible values: **notDelivered**, **fraud**.",
|
||||
"$ref" : "#/components/schemas/DisputeType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PatchableDisputeRequest" : {
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"fraudInfo" : {
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
"url" : "https://github.com/Adyen/adyen-openapi"
|
||||
},
|
||||
"version" : "3",
|
||||
"x-timestamp" : "2024-10-29T23:27:38Z"
|
||||
"x-timestamp" : "2024-11-04T21:26:21Z"
|
||||
},
|
||||
"tags" : [ {
|
||||
"name" : "Dispute Attachments"
|
||||
@@ -54,7 +54,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
},
|
||||
"post" : {
|
||||
"tags" : [ "Dispute Attachments" ],
|
||||
@@ -92,7 +92,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
}
|
||||
},
|
||||
"/disputes/{disputeId}/attachments/{attachmentId}" : {
|
||||
@@ -130,7 +130,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
},
|
||||
"delete" : {
|
||||
"tags" : [ "Dispute Attachments" ],
|
||||
@@ -162,7 +162,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
}
|
||||
},
|
||||
"/disputes" : {
|
||||
@@ -222,14 +222,14 @@
|
||||
"schema" : {
|
||||
"type" : "array",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
},
|
||||
"post" : {
|
||||
"tags" : [ "Raise Disputes" ],
|
||||
@@ -240,7 +240,7 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -252,13 +252,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
}
|
||||
},
|
||||
"/disputes/{id}" : {
|
||||
@@ -282,13 +282,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
},
|
||||
"patch" : {
|
||||
"tags" : [ "Raise Disputes" ],
|
||||
@@ -308,7 +308,7 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/PatchableDisputeDTO"
|
||||
"$ref" : "#/components/schemas/PatchableDisputeRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -319,13 +319,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -390,15 +390,10 @@
|
||||
"type" : "string",
|
||||
"enum" : [ "merchant", "cardholder" ]
|
||||
},
|
||||
"DisputeDTO" : {
|
||||
"DisputeRequest" : {
|
||||
"required" : [ "transactionId", "type" ],
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"arn" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the `arn` to trace the transaction through its lifecycle.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"description" : {
|
||||
"type" : "string",
|
||||
"description" : "Your description for the dispute."
|
||||
@@ -411,11 +406,6 @@
|
||||
"description" : "Additional information for raising a dispute of `type` **fraud**. Required for disputes of `type` **fraud**.",
|
||||
"$ref" : "#/components/schemas/FraudInfo"
|
||||
},
|
||||
"id" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique identifier of the raised dispute.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"notDeliveredInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **notDelivered**. Required for disputes of `type` **notDelivered**.",
|
||||
"$ref" : "#/components/schemas/NotDeliveredInfo"
|
||||
@@ -496,7 +486,51 @@
|
||||
"type" : "string",
|
||||
"enum" : [ "goods", "services" ]
|
||||
},
|
||||
"PatchableDisputeDTO" : {
|
||||
"DisputeResponse" : {
|
||||
"required" : [ "transactionId", "type" ],
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"arn" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the `arn` to trace the transaction through its lifecycle.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"description" : {
|
||||
"type" : "string",
|
||||
"description" : "Your description for the dispute."
|
||||
},
|
||||
"disputedAmount" : {
|
||||
"description" : "The amount for which you dispute the transaction. The disputed amount cannot be greater than the transaction amount. If you do not provide an amount, the entire transaction amount will be disputed.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"fraudInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **fraud**. Required for disputes of `type` **fraud**.",
|
||||
"$ref" : "#/components/schemas/FraudInfo"
|
||||
},
|
||||
"id" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique identifier of the raised dispute.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"notDeliveredInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **notDelivered**. Required for disputes of `type` **notDelivered**.",
|
||||
"$ref" : "#/components/schemas/NotDeliveredInfo"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The current status of the dispute.\n\nYou can update a dispute to **submitted** or **closed**.\n\nPossible values: **draft**, **submitted**, **closed**, **won**, **chargeback**, **secondPresentment**.",
|
||||
"$ref" : "#/components/schemas/DisputeStatus"
|
||||
},
|
||||
"transactionId" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique reference of the transaction for which you are raising the dispute."
|
||||
},
|
||||
"type" : {
|
||||
"description" : "The type of the dispute.\n\nPossible values: **notDelivered**, **fraud**.",
|
||||
"$ref" : "#/components/schemas/DisputeType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PatchableDisputeRequest" : {
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"fraudInfo" : {
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
"url" : "https://github.com/Adyen/adyen-openapi"
|
||||
},
|
||||
"version" : "4",
|
||||
"x-timestamp" : "2024-10-29T23:27:38Z"
|
||||
"x-timestamp" : "2024-11-04T21:26:22Z"
|
||||
},
|
||||
"tags" : [ {
|
||||
"name" : "Dispute Attachments"
|
||||
@@ -54,7 +54,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
},
|
||||
"post" : {
|
||||
"tags" : [ "Dispute Attachments" ],
|
||||
@@ -92,7 +92,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
}
|
||||
},
|
||||
"/disputes/{disputeId}/attachments/{attachmentId}" : {
|
||||
@@ -130,7 +130,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
},
|
||||
"delete" : {
|
||||
"tags" : [ "Dispute Attachments" ],
|
||||
@@ -162,7 +162,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 2
|
||||
}
|
||||
},
|
||||
"/disputes" : {
|
||||
@@ -222,14 +222,14 @@
|
||||
"schema" : {
|
||||
"type" : "array",
|
||||
"items" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
},
|
||||
"post" : {
|
||||
"tags" : [ "Raise Disputes" ],
|
||||
@@ -240,7 +240,7 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -252,13 +252,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
}
|
||||
},
|
||||
"/disputes/{id}" : {
|
||||
@@ -282,13 +282,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
},
|
||||
"patch" : {
|
||||
"tags" : [ "Raise Disputes" ],
|
||||
@@ -308,7 +308,7 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/PatchableDisputeDTO"
|
||||
"$ref" : "#/components/schemas/PatchableDisputeRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -319,13 +319,13 @@
|
||||
"content" : {
|
||||
"application/json" : {
|
||||
"schema" : {
|
||||
"$ref" : "#/components/schemas/DisputeDTO"
|
||||
"$ref" : "#/components/schemas/DisputeResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-sortIndex" : 0
|
||||
"x-sortIndex" : 1
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -390,15 +390,10 @@
|
||||
"type" : "string",
|
||||
"enum" : [ "merchant", "cardholder" ]
|
||||
},
|
||||
"DisputeDTO" : {
|
||||
"DisputeRequest" : {
|
||||
"required" : [ "transactionId", "type" ],
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"arn" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the `arn` to trace the transaction through its lifecycle.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"description" : {
|
||||
"type" : "string",
|
||||
"description" : "Your description for the dispute."
|
||||
@@ -411,11 +406,6 @@
|
||||
"description" : "Additional information for raising a dispute of `type` **fraud**. Required for disputes of `type` **fraud**.",
|
||||
"$ref" : "#/components/schemas/FraudInfo"
|
||||
},
|
||||
"id" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique identifier of the raised dispute.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"notDeliveredInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **notDelivered**. Required for disputes of `type` **notDelivered**.",
|
||||
"$ref" : "#/components/schemas/NotDeliveredInfo"
|
||||
@@ -496,7 +486,51 @@
|
||||
"type" : "string",
|
||||
"enum" : [ "goods", "services" ]
|
||||
},
|
||||
"PatchableDisputeDTO" : {
|
||||
"DisputeResponse" : {
|
||||
"required" : [ "transactionId", "type" ],
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"arn" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the `arn` to trace the transaction through its lifecycle.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"description" : {
|
||||
"type" : "string",
|
||||
"description" : "Your description for the dispute."
|
||||
},
|
||||
"disputedAmount" : {
|
||||
"description" : "The amount for which you dispute the transaction. The disputed amount cannot be greater than the transaction amount. If you do not provide an amount, the entire transaction amount will be disputed.",
|
||||
"$ref" : "#/components/schemas/Amount"
|
||||
},
|
||||
"fraudInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **fraud**. Required for disputes of `type` **fraud**.",
|
||||
"$ref" : "#/components/schemas/FraudInfo"
|
||||
},
|
||||
"id" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique identifier of the raised dispute.",
|
||||
"readOnly" : true
|
||||
},
|
||||
"notDeliveredInfo" : {
|
||||
"description" : "Additional information for raising a dispute of `type` **notDelivered**. Required for disputes of `type` **notDelivered**.",
|
||||
"$ref" : "#/components/schemas/NotDeliveredInfo"
|
||||
},
|
||||
"status" : {
|
||||
"description" : "The current status of the dispute.\n\nYou can update a dispute to **submitted** or **closed**.\n\nPossible values: **draft**, **submitted**, **closed**, **won**, **chargeback**, **secondPresentment**.",
|
||||
"$ref" : "#/components/schemas/DisputeStatus"
|
||||
},
|
||||
"transactionId" : {
|
||||
"type" : "string",
|
||||
"description" : "The unique reference of the transaction for which you are raising the dispute."
|
||||
},
|
||||
"type" : {
|
||||
"description" : "The type of the dispute.\n\nPossible values: **notDelivered**, **fraud**.",
|
||||
"$ref" : "#/components/schemas/DisputeType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PatchableDisputeRequest" : {
|
||||
"type" : "object",
|
||||
"properties" : {
|
||||
"fraudInfo" : {
|
||||
|
||||
@@ -13,19 +13,19 @@ info:
|
||||
name: Adyen Developer Experience team
|
||||
url: https://github.com/Adyen/adyen-openapi
|
||||
tags:
|
||||
- name: Dispute/Chargeback
|
||||
- name: General
|
||||
webhooks:
|
||||
balancePlatform.dispute.created:
|
||||
post:
|
||||
tags:
|
||||
- Dispute/Chargeback
|
||||
summary: Dispute is created
|
||||
- General
|
||||
summary: Dispute created
|
||||
description: 'Adyen sends this webhook when a dispute is created. This webhook
|
||||
only informs your server of requests. '
|
||||
x-addedInVersion: '1'
|
||||
operationId: post-balancePlatform.dispute.created
|
||||
x-sortIndex: 1
|
||||
x-methodName: disputeIsCreated
|
||||
x-methodName: disputeCreated
|
||||
security:
|
||||
- BasicAuth: []
|
||||
requestBody:
|
||||
@@ -43,14 +43,14 @@ webhooks:
|
||||
balancePlatform.dispute.updated:
|
||||
post:
|
||||
tags:
|
||||
- Dispute/Chargeback
|
||||
summary: Dispute is updated
|
||||
- General
|
||||
summary: Dispute updated
|
||||
description: 'Adyen sends this webhook when a dispute is updated. This webhook
|
||||
only informs your server of requests. '
|
||||
x-addedInVersion: '1'
|
||||
operationId: post-balancePlatform.dispute.updated
|
||||
x-sortIndex: 1
|
||||
x-methodName: disputeIsUpdated
|
||||
x-methodName: disputeUpdated
|
||||
security:
|
||||
- BasicAuth: []
|
||||
requestBody:
|
||||
@@ -117,19 +117,23 @@ components:
|
||||
id:
|
||||
description: The ID of the resource.
|
||||
type: string
|
||||
reason:
|
||||
description: The reason for which you dispute the transaction.
|
||||
enum:
|
||||
- fraud
|
||||
- notDelivered
|
||||
type: string
|
||||
status:
|
||||
description: The current status of the dispute.
|
||||
type: string
|
||||
statusDetail:
|
||||
description: Additional information about the status of the dispute, when
|
||||
available.
|
||||
type: string
|
||||
transactionId:
|
||||
description: The unique reference of the transaction for which the dispute
|
||||
is requested.
|
||||
type: string
|
||||
type:
|
||||
description: The type of dispute raised for the transaction.
|
||||
enum:
|
||||
- fraud
|
||||
- notDelivered
|
||||
type: string
|
||||
type: object
|
||||
DisputeNotificationRequest:
|
||||
additionalProperties: false
|
||||
|
||||
@@ -30,7 +30,7 @@ info:
|
||||
name: Adyen Developer Experience team
|
||||
url: https://github.com/Adyen/adyen-openapi
|
||||
version: '1'
|
||||
x-timestamp: '2024-10-29T23:27:38Z'
|
||||
x-timestamp: '2024-11-04T21:26:21Z'
|
||||
tags:
|
||||
- name: Dispute Attachments
|
||||
- name: Raise Disputes
|
||||
@@ -58,7 +58,7 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/DisputeAttachment'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
post:
|
||||
tags:
|
||||
- Dispute Attachments
|
||||
@@ -87,7 +87,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AttachDocumentResponse'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
/disputes/{disputeId}/attachments/{attachmentId}:
|
||||
get:
|
||||
tags:
|
||||
@@ -116,7 +116,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeAttachment'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
delete:
|
||||
tags:
|
||||
- Dispute Attachments
|
||||
@@ -143,7 +143,7 @@ paths:
|
||||
there is no additional content.
|
||||
content:
|
||||
application/json: {}
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
/disputes:
|
||||
get:
|
||||
tags:
|
||||
@@ -205,8 +205,8 @@ paths:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
post:
|
||||
tags:
|
||||
- Raise Disputes
|
||||
@@ -224,7 +224,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
$ref: '#/components/schemas/DisputeRequest'
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
@@ -232,8 +232,8 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
/disputes/{id}:
|
||||
get:
|
||||
tags:
|
||||
@@ -254,8 +254,8 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
patch:
|
||||
tags:
|
||||
- Raise Disputes
|
||||
@@ -283,15 +283,15 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PatchableDisputeDTO'
|
||||
$ref: '#/components/schemas/PatchableDisputeRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: OK - the request has succeeded.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
components:
|
||||
schemas:
|
||||
AttachmentType:
|
||||
@@ -351,18 +351,12 @@ components:
|
||||
enum:
|
||||
- merchant
|
||||
- cardholder
|
||||
DisputeDTO:
|
||||
DisputeRequest:
|
||||
required:
|
||||
- transactionId
|
||||
- type
|
||||
type: object
|
||||
properties:
|
||||
arn:
|
||||
type: string
|
||||
description: The unique Acquirer Reference Number (arn) generated by the
|
||||
card scheme for each capture. You can use the `arn` to trace the transaction
|
||||
through its lifecycle.
|
||||
readOnly: true
|
||||
description:
|
||||
type: string
|
||||
description: Your description for the dispute.
|
||||
@@ -375,10 +369,6 @@ components:
|
||||
description: Additional information for raising a dispute of `type` **fraud**.
|
||||
Required for disputes of `type` **fraud**.
|
||||
$ref: '#/components/schemas/FraudInfo'
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier of the raised dispute.
|
||||
readOnly: true
|
||||
notDeliveredInfo:
|
||||
description: Additional information for raising a dispute of `type` **notDelivered**.
|
||||
Required for disputes of `type` **notDelivered**.
|
||||
@@ -478,7 +468,59 @@ components:
|
||||
enum:
|
||||
- goods
|
||||
- services
|
||||
PatchableDisputeDTO:
|
||||
DisputeResponse:
|
||||
required:
|
||||
- transactionId
|
||||
- type
|
||||
type: object
|
||||
properties:
|
||||
arn:
|
||||
type: string
|
||||
description: The unique Acquirer Reference Number (arn) generated by the
|
||||
card scheme for each capture. You can use the `arn` to trace the transaction
|
||||
through its lifecycle.
|
||||
readOnly: true
|
||||
description:
|
||||
type: string
|
||||
description: Your description for the dispute.
|
||||
disputedAmount:
|
||||
description: The amount for which you dispute the transaction. The disputed
|
||||
amount cannot be greater than the transaction amount. If you do not provide
|
||||
an amount, the entire transaction amount will be disputed.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
fraudInfo:
|
||||
description: Additional information for raising a dispute of `type` **fraud**.
|
||||
Required for disputes of `type` **fraud**.
|
||||
$ref: '#/components/schemas/FraudInfo'
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier of the raised dispute.
|
||||
readOnly: true
|
||||
notDeliveredInfo:
|
||||
description: Additional information for raising a dispute of `type` **notDelivered**.
|
||||
Required for disputes of `type` **notDelivered**.
|
||||
$ref: '#/components/schemas/NotDeliveredInfo'
|
||||
status:
|
||||
description: 'The current status of the dispute.
|
||||
|
||||
|
||||
You can update a dispute to **submitted** or **closed**.
|
||||
|
||||
|
||||
Possible values: **draft**, **submitted**, **closed**, **won**, **chargeback**,
|
||||
**secondPresentment**.'
|
||||
$ref: '#/components/schemas/DisputeStatus'
|
||||
transactionId:
|
||||
type: string
|
||||
description: The unique reference of the transaction for which you are raising
|
||||
the dispute.
|
||||
type:
|
||||
description: 'The type of the dispute.
|
||||
|
||||
|
||||
Possible values: **notDelivered**, **fraud**.'
|
||||
$ref: '#/components/schemas/DisputeType'
|
||||
PatchableDisputeRequest:
|
||||
type: object
|
||||
properties:
|
||||
fraudInfo:
|
||||
|
||||
@@ -30,7 +30,7 @@ info:
|
||||
name: Adyen Developer Experience team
|
||||
url: https://github.com/Adyen/adyen-openapi
|
||||
version: '2'
|
||||
x-timestamp: '2024-10-29T23:27:38Z'
|
||||
x-timestamp: '2024-11-04T21:26:21Z'
|
||||
tags:
|
||||
- name: Dispute Attachments
|
||||
- name: Raise Disputes
|
||||
@@ -58,7 +58,7 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/DisputeAttachment'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
post:
|
||||
tags:
|
||||
- Dispute Attachments
|
||||
@@ -87,7 +87,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AttachDocumentResponse'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
/disputes/{disputeId}/attachments/{attachmentId}:
|
||||
get:
|
||||
tags:
|
||||
@@ -116,7 +116,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeAttachment'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
delete:
|
||||
tags:
|
||||
- Dispute Attachments
|
||||
@@ -143,7 +143,7 @@ paths:
|
||||
there is no additional content.
|
||||
content:
|
||||
application/json: {}
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
/disputes:
|
||||
get:
|
||||
tags:
|
||||
@@ -205,8 +205,8 @@ paths:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
post:
|
||||
tags:
|
||||
- Raise Disputes
|
||||
@@ -224,7 +224,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
$ref: '#/components/schemas/DisputeRequest'
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
@@ -232,8 +232,8 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
/disputes/{id}:
|
||||
get:
|
||||
tags:
|
||||
@@ -254,8 +254,8 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
patch:
|
||||
tags:
|
||||
- Raise Disputes
|
||||
@@ -283,15 +283,15 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PatchableDisputeDTO'
|
||||
$ref: '#/components/schemas/PatchableDisputeRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: OK - the request has succeeded.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
components:
|
||||
schemas:
|
||||
AttachmentType:
|
||||
@@ -351,18 +351,12 @@ components:
|
||||
enum:
|
||||
- merchant
|
||||
- cardholder
|
||||
DisputeDTO:
|
||||
DisputeRequest:
|
||||
required:
|
||||
- transactionId
|
||||
- type
|
||||
type: object
|
||||
properties:
|
||||
arn:
|
||||
type: string
|
||||
description: The unique Acquirer Reference Number (arn) generated by the
|
||||
card scheme for each capture. You can use the `arn` to trace the transaction
|
||||
through its lifecycle.
|
||||
readOnly: true
|
||||
description:
|
||||
type: string
|
||||
description: Your description for the dispute.
|
||||
@@ -375,10 +369,6 @@ components:
|
||||
description: Additional information for raising a dispute of `type` **fraud**.
|
||||
Required for disputes of `type` **fraud**.
|
||||
$ref: '#/components/schemas/FraudInfo'
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier of the raised dispute.
|
||||
readOnly: true
|
||||
notDeliveredInfo:
|
||||
description: Additional information for raising a dispute of `type` **notDelivered**.
|
||||
Required for disputes of `type` **notDelivered**.
|
||||
@@ -478,7 +468,59 @@ components:
|
||||
enum:
|
||||
- goods
|
||||
- services
|
||||
PatchableDisputeDTO:
|
||||
DisputeResponse:
|
||||
required:
|
||||
- transactionId
|
||||
- type
|
||||
type: object
|
||||
properties:
|
||||
arn:
|
||||
type: string
|
||||
description: The unique Acquirer Reference Number (arn) generated by the
|
||||
card scheme for each capture. You can use the `arn` to trace the transaction
|
||||
through its lifecycle.
|
||||
readOnly: true
|
||||
description:
|
||||
type: string
|
||||
description: Your description for the dispute.
|
||||
disputedAmount:
|
||||
description: The amount for which you dispute the transaction. The disputed
|
||||
amount cannot be greater than the transaction amount. If you do not provide
|
||||
an amount, the entire transaction amount will be disputed.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
fraudInfo:
|
||||
description: Additional information for raising a dispute of `type` **fraud**.
|
||||
Required for disputes of `type` **fraud**.
|
||||
$ref: '#/components/schemas/FraudInfo'
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier of the raised dispute.
|
||||
readOnly: true
|
||||
notDeliveredInfo:
|
||||
description: Additional information for raising a dispute of `type` **notDelivered**.
|
||||
Required for disputes of `type` **notDelivered**.
|
||||
$ref: '#/components/schemas/NotDeliveredInfo'
|
||||
status:
|
||||
description: 'The current status of the dispute.
|
||||
|
||||
|
||||
You can update a dispute to **submitted** or **closed**.
|
||||
|
||||
|
||||
Possible values: **draft**, **submitted**, **closed**, **won**, **chargeback**,
|
||||
**secondPresentment**.'
|
||||
$ref: '#/components/schemas/DisputeStatus'
|
||||
transactionId:
|
||||
type: string
|
||||
description: The unique reference of the transaction for which you are raising
|
||||
the dispute.
|
||||
type:
|
||||
description: 'The type of the dispute.
|
||||
|
||||
|
||||
Possible values: **notDelivered**, **fraud**.'
|
||||
$ref: '#/components/schemas/DisputeType'
|
||||
PatchableDisputeRequest:
|
||||
type: object
|
||||
properties:
|
||||
fraudInfo:
|
||||
|
||||
@@ -30,7 +30,7 @@ info:
|
||||
name: Adyen Developer Experience team
|
||||
url: https://github.com/Adyen/adyen-openapi
|
||||
version: '3'
|
||||
x-timestamp: '2024-10-29T23:27:38Z'
|
||||
x-timestamp: '2024-11-04T21:26:21Z'
|
||||
tags:
|
||||
- name: Dispute Attachments
|
||||
- name: Raise Disputes
|
||||
@@ -58,7 +58,7 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/DisputeAttachment'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
post:
|
||||
tags:
|
||||
- Dispute Attachments
|
||||
@@ -87,7 +87,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AttachDocumentResponse'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
/disputes/{disputeId}/attachments/{attachmentId}:
|
||||
get:
|
||||
tags:
|
||||
@@ -116,7 +116,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeAttachment'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
delete:
|
||||
tags:
|
||||
- Dispute Attachments
|
||||
@@ -143,7 +143,7 @@ paths:
|
||||
there is no additional content.
|
||||
content:
|
||||
application/json: {}
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
/disputes:
|
||||
get:
|
||||
tags:
|
||||
@@ -205,8 +205,8 @@ paths:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
post:
|
||||
tags:
|
||||
- Raise Disputes
|
||||
@@ -224,7 +224,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
$ref: '#/components/schemas/DisputeRequest'
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
@@ -232,8 +232,8 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
/disputes/{id}:
|
||||
get:
|
||||
tags:
|
||||
@@ -254,8 +254,8 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
patch:
|
||||
tags:
|
||||
- Raise Disputes
|
||||
@@ -283,15 +283,15 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PatchableDisputeDTO'
|
||||
$ref: '#/components/schemas/PatchableDisputeRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: OK - the request has succeeded.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
components:
|
||||
schemas:
|
||||
AttachmentType:
|
||||
@@ -351,18 +351,12 @@ components:
|
||||
enum:
|
||||
- merchant
|
||||
- cardholder
|
||||
DisputeDTO:
|
||||
DisputeRequest:
|
||||
required:
|
||||
- transactionId
|
||||
- type
|
||||
type: object
|
||||
properties:
|
||||
arn:
|
||||
type: string
|
||||
description: The unique Acquirer Reference Number (arn) generated by the
|
||||
card scheme for each capture. You can use the `arn` to trace the transaction
|
||||
through its lifecycle.
|
||||
readOnly: true
|
||||
description:
|
||||
type: string
|
||||
description: Your description for the dispute.
|
||||
@@ -375,10 +369,6 @@ components:
|
||||
description: Additional information for raising a dispute of `type` **fraud**.
|
||||
Required for disputes of `type` **fraud**.
|
||||
$ref: '#/components/schemas/FraudInfo'
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier of the raised dispute.
|
||||
readOnly: true
|
||||
notDeliveredInfo:
|
||||
description: Additional information for raising a dispute of `type` **notDelivered**.
|
||||
Required for disputes of `type` **notDelivered**.
|
||||
@@ -478,7 +468,59 @@ components:
|
||||
enum:
|
||||
- goods
|
||||
- services
|
||||
PatchableDisputeDTO:
|
||||
DisputeResponse:
|
||||
required:
|
||||
- transactionId
|
||||
- type
|
||||
type: object
|
||||
properties:
|
||||
arn:
|
||||
type: string
|
||||
description: The unique Acquirer Reference Number (arn) generated by the
|
||||
card scheme for each capture. You can use the `arn` to trace the transaction
|
||||
through its lifecycle.
|
||||
readOnly: true
|
||||
description:
|
||||
type: string
|
||||
description: Your description for the dispute.
|
||||
disputedAmount:
|
||||
description: The amount for which you dispute the transaction. The disputed
|
||||
amount cannot be greater than the transaction amount. If you do not provide
|
||||
an amount, the entire transaction amount will be disputed.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
fraudInfo:
|
||||
description: Additional information for raising a dispute of `type` **fraud**.
|
||||
Required for disputes of `type` **fraud**.
|
||||
$ref: '#/components/schemas/FraudInfo'
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier of the raised dispute.
|
||||
readOnly: true
|
||||
notDeliveredInfo:
|
||||
description: Additional information for raising a dispute of `type` **notDelivered**.
|
||||
Required for disputes of `type` **notDelivered**.
|
||||
$ref: '#/components/schemas/NotDeliveredInfo'
|
||||
status:
|
||||
description: 'The current status of the dispute.
|
||||
|
||||
|
||||
You can update a dispute to **submitted** or **closed**.
|
||||
|
||||
|
||||
Possible values: **draft**, **submitted**, **closed**, **won**, **chargeback**,
|
||||
**secondPresentment**.'
|
||||
$ref: '#/components/schemas/DisputeStatus'
|
||||
transactionId:
|
||||
type: string
|
||||
description: The unique reference of the transaction for which you are raising
|
||||
the dispute.
|
||||
type:
|
||||
description: 'The type of the dispute.
|
||||
|
||||
|
||||
Possible values: **notDelivered**, **fraud**.'
|
||||
$ref: '#/components/schemas/DisputeType'
|
||||
PatchableDisputeRequest:
|
||||
type: object
|
||||
properties:
|
||||
fraudInfo:
|
||||
|
||||
@@ -30,7 +30,7 @@ info:
|
||||
name: Adyen Developer Experience team
|
||||
url: https://github.com/Adyen/adyen-openapi
|
||||
version: '4'
|
||||
x-timestamp: '2024-10-29T23:27:38Z'
|
||||
x-timestamp: '2024-11-04T21:26:22Z'
|
||||
tags:
|
||||
- name: Dispute Attachments
|
||||
- name: Raise Disputes
|
||||
@@ -58,7 +58,7 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/DisputeAttachment'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
post:
|
||||
tags:
|
||||
- Dispute Attachments
|
||||
@@ -87,7 +87,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AttachDocumentResponse'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
/disputes/{disputeId}/attachments/{attachmentId}:
|
||||
get:
|
||||
tags:
|
||||
@@ -116,7 +116,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeAttachment'
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
delete:
|
||||
tags:
|
||||
- Dispute Attachments
|
||||
@@ -143,7 +143,7 @@ paths:
|
||||
there is no additional content.
|
||||
content:
|
||||
application/json: {}
|
||||
x-sortIndex: 0
|
||||
x-sortIndex: 2
|
||||
/disputes:
|
||||
get:
|
||||
tags:
|
||||
@@ -205,8 +205,8 @@ paths:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
post:
|
||||
tags:
|
||||
- Raise Disputes
|
||||
@@ -224,7 +224,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
$ref: '#/components/schemas/DisputeRequest'
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
@@ -232,8 +232,8 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
/disputes/{id}:
|
||||
get:
|
||||
tags:
|
||||
@@ -254,8 +254,8 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
patch:
|
||||
tags:
|
||||
- Raise Disputes
|
||||
@@ -283,15 +283,15 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PatchableDisputeDTO'
|
||||
$ref: '#/components/schemas/PatchableDisputeRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: OK - the request has succeeded.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DisputeDTO'
|
||||
x-sortIndex: 0
|
||||
$ref: '#/components/schemas/DisputeResponse'
|
||||
x-sortIndex: 1
|
||||
components:
|
||||
schemas:
|
||||
AttachmentType:
|
||||
@@ -351,18 +351,12 @@ components:
|
||||
enum:
|
||||
- merchant
|
||||
- cardholder
|
||||
DisputeDTO:
|
||||
DisputeRequest:
|
||||
required:
|
||||
- transactionId
|
||||
- type
|
||||
type: object
|
||||
properties:
|
||||
arn:
|
||||
type: string
|
||||
description: The unique Acquirer Reference Number (arn) generated by the
|
||||
card scheme for each capture. You can use the `arn` to trace the transaction
|
||||
through its lifecycle.
|
||||
readOnly: true
|
||||
description:
|
||||
type: string
|
||||
description: Your description for the dispute.
|
||||
@@ -375,10 +369,6 @@ components:
|
||||
description: Additional information for raising a dispute of `type` **fraud**.
|
||||
Required for disputes of `type` **fraud**.
|
||||
$ref: '#/components/schemas/FraudInfo'
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier of the raised dispute.
|
||||
readOnly: true
|
||||
notDeliveredInfo:
|
||||
description: Additional information for raising a dispute of `type` **notDelivered**.
|
||||
Required for disputes of `type` **notDelivered**.
|
||||
@@ -478,7 +468,59 @@ components:
|
||||
enum:
|
||||
- goods
|
||||
- services
|
||||
PatchableDisputeDTO:
|
||||
DisputeResponse:
|
||||
required:
|
||||
- transactionId
|
||||
- type
|
||||
type: object
|
||||
properties:
|
||||
arn:
|
||||
type: string
|
||||
description: The unique Acquirer Reference Number (arn) generated by the
|
||||
card scheme for each capture. You can use the `arn` to trace the transaction
|
||||
through its lifecycle.
|
||||
readOnly: true
|
||||
description:
|
||||
type: string
|
||||
description: Your description for the dispute.
|
||||
disputedAmount:
|
||||
description: The amount for which you dispute the transaction. The disputed
|
||||
amount cannot be greater than the transaction amount. If you do not provide
|
||||
an amount, the entire transaction amount will be disputed.
|
||||
$ref: '#/components/schemas/Amount'
|
||||
fraudInfo:
|
||||
description: Additional information for raising a dispute of `type` **fraud**.
|
||||
Required for disputes of `type` **fraud**.
|
||||
$ref: '#/components/schemas/FraudInfo'
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier of the raised dispute.
|
||||
readOnly: true
|
||||
notDeliveredInfo:
|
||||
description: Additional information for raising a dispute of `type` **notDelivered**.
|
||||
Required for disputes of `type` **notDelivered**.
|
||||
$ref: '#/components/schemas/NotDeliveredInfo'
|
||||
status:
|
||||
description: 'The current status of the dispute.
|
||||
|
||||
|
||||
You can update a dispute to **submitted** or **closed**.
|
||||
|
||||
|
||||
Possible values: **draft**, **submitted**, **closed**, **won**, **chargeback**,
|
||||
**secondPresentment**.'
|
||||
$ref: '#/components/schemas/DisputeStatus'
|
||||
transactionId:
|
||||
type: string
|
||||
description: The unique reference of the transaction for which you are raising
|
||||
the dispute.
|
||||
type:
|
||||
description: 'The type of the dispute.
|
||||
|
||||
|
||||
Possible values: **notDelivered**, **fraud**.'
|
||||
$ref: '#/components/schemas/DisputeType'
|
||||
PatchableDisputeRequest:
|
||||
type: object
|
||||
properties:
|
||||
fraudInfo:
|
||||
|
||||
Reference in New Issue
Block a user