Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Nov 22, 2024
1 parent d1f265e commit db47f83
Show file tree
Hide file tree
Showing 10 changed files with 556 additions and 244 deletions.
34 changes: 19 additions & 15 deletions json/BalancePlatformDisputeNotification-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" : [
Expand Down Expand Up @@ -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" : [
Expand Down Expand Up @@ -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"
Expand Down
88 changes: 61 additions & 27 deletions json/TransactionService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -54,7 +54,7 @@
}
}
},
"x-sortIndex" : 0
"x-sortIndex" : 2
},
"post" : {
"tags" : [ "Dispute Attachments" ],
Expand Down Expand Up @@ -92,7 +92,7 @@
}
}
},
"x-sortIndex" : 0
"x-sortIndex" : 2
}
},
"/disputes/{disputeId}/attachments/{attachmentId}" : {
Expand Down Expand Up @@ -130,7 +130,7 @@
}
}
},
"x-sortIndex" : 0
"x-sortIndex" : 2
},
"delete" : {
"tags" : [ "Dispute Attachments" ],
Expand Down Expand Up @@ -162,7 +162,7 @@
}
}
},
"x-sortIndex" : 0
"x-sortIndex" : 2
}
},
"/disputes" : {
Expand Down Expand Up @@ -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" ],
Expand All @@ -240,7 +240,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisputeDTO"
"$ref" : "#/components/schemas/DisputeRequest"
}
}
},
Expand All @@ -252,13 +252,13 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisputeDTO"
"$ref" : "#/components/schemas/DisputeResponse"
}
}
}
}
},
"x-sortIndex" : 0
"x-sortIndex" : 1
}
},
"/disputes/{id}" : {
Expand All @@ -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" ],
Expand All @@ -308,7 +308,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PatchableDisputeDTO"
"$ref" : "#/components/schemas/PatchableDisputeRequest"
}
}
}
Expand All @@ -319,13 +319,13 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisputeDTO"
"$ref" : "#/components/schemas/DisputeResponse"
}
}
}
}
},
"x-sortIndex" : 0
"x-sortIndex" : 1
}
}
},
Expand Down Expand Up @@ -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."
Expand All @@ -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"
Expand Down Expand Up @@ -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" : {
Expand Down
Loading

0 comments on commit db47f83

Please sign in to comment.