{"_id":"565df10094f30d0d00d1f3f3","user":"55f8467359eace0d0087db7e","project":"55dd0853d2d97337001800e2","__v":10,"githubsync":"","version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"category":{"_id":"55e4e0bae252ac0d00303a9d","__v":9,"project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","pages":["55e5ee529416190d00dc3a40","55ea2099c584fb2300291df8","55ea2101c584fb2300291df9","55ea219cc62aa02f008229ce","55ea21e14f4b23230046f6fc","55ea230e0b48a121002ab3ec","55ea235b0b48a121002ab3ee","565df10094f30d0d00d1f3f3","565e0b2360497d1700ecce6d"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-31T23:18:18.658Z","from_sync":false,"order":16,"slug":"disputes","title":"Disputes"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-01T19:12:00.261Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"What is a dispute?\",\n  \"body\": \"Disputes occur when a payment has been challenged by a consumer or a third party provider as an invalid payment. If a dispute is \\\"lost\\\", then the disputed amount is returned to the customer at the Merchant's expense.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Bank payment disputes\",\n  \"body\": \"Bank disputes cannot be challenged by the Merchant. A disputed bank payment is considered to be \\\"lost\\\" and all of the disputed amount will be returned to the consumer immediately.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Card payment disputes\",\n  \"body\": \"Card disputes can be challenged by the Merchant by submitting evidence on their behalf. If a Merchant challenges a dispute and wins, the Merchant will keep the disputed amount. If the dispute is lost, the disputed amount will be returned to the consumer.\"\n}\n[/block]\n## Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Specification\",\n    \"0-0\": \"description\",\n    \"1-0\": \"meta\",\n    \"0-1\": \"**Type**: String\\n**Length**: 0-512 characters\\n**Description**: An optional short description that describes the reason for the refund.\",\n    \"1-1\": \"**Type**: JSON Object\\n**Format**: [Meta](doc:meta) \\n**Description**: An optional object to store custom data for the Payment.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n## Response\n\nAll of the parameters from the Request get returned in the Response. In addition, the following parameters also get returned in the response.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"object\",\n    \"2-0\": \"paymentId\",\n    \"3-0\": \"amount\",\n    \"4-0\": \"currency\",\n    \"7-0\": \"status\",\n    \"8-0\": \"created\",\n    \"9-0\": \"lastUpdated\",\n    \"0-1\": \"The unique identifier for the dispute.\",\n    \"1-1\": \"Will have value \\\"dispute\\\" indicating that the object is a dispute response.\",\n    \"2-1\": \"The id of the payment associated with the dispute.\",\n    \"9-1\": \"The date the dispute was last updated.\",\n    \"8-1\": \"The date the dispute was created.\",\n    \"7-1\": \"The current status of the dispute. One of: \\\"created\\\", \\\"processing\\\", \\\"acceptingEvidence\\\", \\\"underReview\\\", \\\"won\\\", \\\"lost\\\"\",\n    \"4-1\": \"The currency for the dispute.\",\n    \"3-1\": \"The amount of the dispute.\",\n    \"5-0\": \"evidenceSubmitted\",\n    \"6-0\": \"closed\",\n    \"5-1\": \"Boolean indicating if evidence has been submitted for the dispute.\",\n    \"6-1\": \"Boolean indicating if the dispute is closed to accepting new evidence.\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"r5asl6umgaj3k47ixztdfka1\\\",\\n  \\\"object\\\": \\\"dispute\\\",\\n  \\\"paymentId\\\": \\\"lzfu2yd6gwrtoo9tf6jpzla8\\\",\\n  \\\"amount\\\": \\\"20.10\\\",\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"description\\\": \\\"Disputed description\\\",\\n  \\\"meta\\\": {..},\\n  \\\"evidenceSubmitted\\\": false,\\n  \\\"closed\\\": false,\\n  \\\"status\\\": \\\"acceptingEvidence\\\",\\n  \\\"created\\\": \\\"2015-10-28T22:55:32.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-29T22:55:32.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Dispute Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"dispute-resource","type":"basic","title":"Dispute resource"}
[block:callout] { "type": "info", "title": "What is a dispute?", "body": "Disputes occur when a payment has been challenged by a consumer or a third party provider as an invalid payment. If a dispute is \"lost\", then the disputed amount is returned to the customer at the Merchant's expense." } [/block] [block:callout] { "type": "danger", "title": "Bank payment disputes", "body": "Bank disputes cannot be challenged by the Merchant. A disputed bank payment is considered to be \"lost\" and all of the disputed amount will be returned to the consumer immediately." } [/block] [block:callout] { "type": "warning", "title": "Card payment disputes", "body": "Card disputes can be challenged by the Merchant by submitting evidence on their behalf. If a Merchant challenges a dispute and wins, the Merchant will keep the disputed amount. If the dispute is lost, the disputed amount will be returned to the consumer." } [/block] ## Request [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Specification", "0-0": "description", "1-0": "meta", "0-1": "**Type**: String\n**Length**: 0-512 characters\n**Description**: An optional short description that describes the reason for the refund.", "1-1": "**Type**: JSON Object\n**Format**: [Meta](doc:meta) \n**Description**: An optional object to store custom data for the Payment." }, "cols": 2, "rows": 2 } [/block] ## Response All of the parameters from the Request get returned in the Response. In addition, the following parameters also get returned in the response. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "id", "1-0": "object", "2-0": "paymentId", "3-0": "amount", "4-0": "currency", "7-0": "status", "8-0": "created", "9-0": "lastUpdated", "0-1": "The unique identifier for the dispute.", "1-1": "Will have value \"dispute\" indicating that the object is a dispute response.", "2-1": "The id of the payment associated with the dispute.", "9-1": "The date the dispute was last updated.", "8-1": "The date the dispute was created.", "7-1": "The current status of the dispute. One of: \"created\", \"processing\", \"acceptingEvidence\", \"underReview\", \"won\", \"lost\"", "4-1": "The currency for the dispute.", "3-1": "The amount of the dispute.", "5-0": "evidenceSubmitted", "6-0": "closed", "5-1": "Boolean indicating if evidence has been submitted for the dispute.", "6-1": "Boolean indicating if the dispute is closed to accepting new evidence." }, "cols": 2, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"r5asl6umgaj3k47ixztdfka1\",\n \"object\": \"dispute\",\n \"paymentId\": \"lzfu2yd6gwrtoo9tf6jpzla8\",\n \"amount\": \"20.10\",\n \"currency\": \"USD\",\n \"description\": \"Disputed description\",\n \"meta\": {..},\n \"evidenceSubmitted\": false,\n \"closed\": false,\n \"status\": \"acceptingEvidence\",\n \"created\": \"2015-10-28T22:55:32.000Z\",\n \"lastUpdated\": \"2015-10-29T22:55:32.000Z\"\n}", "language": "json", "name": "Dispute Response" } ], "sidebar": true } [/block]