{"_id":"58112e72ded0340f0085d056","__v":0,"category":{"_id":"58112e72ded0340f0085d033","project":"551e85be610f400d00837db7","version":"58112e71ded0340f0085d02a","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-25T13:57:54.835Z","from_sync":false,"order":8,"slug":"api-resources","title":"Merchant API Resources"},"parentDoc":null,"project":"551e85be610f400d00837db7","version":{"_id":"58112e71ded0340f0085d02a","project":"551e85be610f400d00837db7","__v":4,"createdAt":"2016-10-26T22:30:09.862Z","releaseDate":"2016-10-26T22:30:09.862Z","categories":["58112e72ded0340f0085d02b","58112e72ded0340f0085d02c","58112e72ded0340f0085d02d","58112e72ded0340f0085d02e","58112e72ded0340f0085d02f","58112e72ded0340f0085d030","58112e72ded0340f0085d031","58112e72ded0340f0085d032","58112e72ded0340f0085d033","58112e72ded0340f0085d034","581137cc604d3c230048b7e4","58dc367221742d0f00a73f98","590768e54669da0f00db5c0b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"new designer","version_clean":"2.0.0","version":"2.0"},"user":"55f2fd49b5b25021002b7dfd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-14T04:33:14.860Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"# Properties\n[block:html]\n{\n  \"html\": \"\\n<div class=\\\"property-table-wrap\\\">\\n    <table class=\\\"property-table\\\">\\n        <thead>\\n            <tr>\\n                <th class=\\\"prop-col\\\">Property</th>\\n                <th class=\\\"filter-col\\\">Filter</th>\\n                <th class=\\\"editable-col\\\">Edit</th>\\n                <th class=\\\"type-col\\\">Type</th>\\n                <th class=\\\"description-col\\\">Description</th>\\n            </tr>\\n        </thead>\\n\\n        <tbody class=\\\"properties\\\">\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">id</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\">Unique identifier</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">created_at</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">DATETIME</td>\\n                <td class=\\\"description-col\\\">Date the transaction was created</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">is_test</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\">Created in test mode</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">result</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">One of<ul>\\n<li>authorized (1)\\n<li>captured (2)\\n<li>failed (3)\\n<li>refunded (4)\\n<li>failed refund (5)<br />When used as a filter, use the integer values rather than the string</li></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">total</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">url</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">Direct link to ```GET``` the full details of the transaction</td>\\n            </tr>\\n\\n            </tbody>\\n    </table>\\n</div>\\n\\n\"\n}\n[/block]\n## Relation Properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Resource\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"**order**\",\n    \"0-1\": \"[Order](doc:order)\",\n    \"0-2\": \"A reference to the Order\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**bold** - may be used to filter collections\n\nThe above properties are references to another Cratejoy resource or another collection of Cratejoy resources.\n\nThe properties can either be a url to fetch the related resources OR contain the resources themselves\n\n### Additional Filters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Proerty\",\n    \"h-1\": \"Type\",\n    \"0-0\": \"**reference_id**\",\n    \"0-1\": \"Int\",\n    \"1-0\": \"**pay_provider_id**\",\n    \"1-1\": \"Int\",\n    \"2-0\": \"**customer_pay_id**\",\n    \"2-1\": \"Int\",\n    \"3-0\": \"**pay_id**\",\n    \"3-1\": \"CustomerPay\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","excerpt":"Transaction data object specification for the Cratejoy Merchant API","slug":"transaction","type":"basic","title":"Transaction"}

Transaction

Transaction data object specification for the Cratejoy Merchant API

# Properties [block:html] { "html": "\n<div class=\"property-table-wrap\">\n <table class=\"property-table\">\n <thead>\n <tr>\n <th class=\"prop-col\">Property</th>\n <th class=\"filter-col\">Filter</th>\n <th class=\"editable-col\">Edit</th>\n <th class=\"type-col\">Type</th>\n <th class=\"description-col\">Description</th>\n </tr>\n </thead>\n\n <tbody class=\"properties\">\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">id</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">Unique identifier</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">created_at</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">DATETIME</td>\n <td class=\"description-col\">Date the transaction was created</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">is_test</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\">Created in test mode</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">result</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">One of<ul>\n<li>authorized (1)\n<li>captured (2)\n<li>failed (3)\n<li>refunded (4)\n<li>failed refund (5)<br />When used as a filter, use the integer values rather than the string</li></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">total</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"ro\">\n <td class=\"prop-col\">url</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Direct link to ```GET``` the full details of the transaction</td>\n </tr>\n\n </tbody>\n </table>\n</div>\n\n" } [/block] ## Relation Properties [block:parameters] { "data": { "h-0": "Property", "h-1": "Resource", "h-2": "Description", "0-0": "**order**", "0-1": "[Order](doc:order)", "0-2": "A reference to the Order" }, "cols": 3, "rows": 1 } [/block] **bold** - may be used to filter collections The above properties are references to another Cratejoy resource or another collection of Cratejoy resources. The properties can either be a url to fetch the related resources OR contain the resources themselves ### Additional Filters [block:parameters] { "data": { "h-0": "Proerty", "h-1": "Type", "0-0": "**reference_id**", "0-1": "Int", "1-0": "**pay_provider_id**", "1-1": "Int", "2-0": "**customer_pay_id**", "2-1": "Int", "3-0": "**pay_id**", "3-1": "CustomerPay" }, "cols": 2, "rows": 4 } [/block]