{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"refund","type":"basic","slug":"refund-1","excerpt":"Contains refund details","body":"These **refund** objects are contained in the **refund** array in the [refunds](doc:refunds) object. \n\n###Request\nN/A\n\n###Response\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`amount`\",\n \"0-1\": \"*decimal*\",\n \"0-2\": \"Refund amount, positive value\",\n \"1-0\": \"`currency`\",\n \"2-0\": \"`date`\",\n \"1-1\": \"*string*\",\n \"2-1\": \"*string*\",\n \"2-2\": \"Refund date\",\n \"1-2\": \"Currency of refund amount\",\n \"4-0\": \"`vendorAmount`\",\n \"4-1\": \"*decimal*\",\n \"4-2\": \"The total vendor portion of the refund amount. Only available if one or more vendor IDs were included in original transaction.\",\n \"5-0\": \"`vendorsRefundInfo`\",\n \"5-1\": \"*object*\",\n \"5-2\": \"See [vendorsRefundInfo](doc:vendorsrefundinfo).\",\n \"3-0\": \"`refundTransactionId`\",\n \"3-1\": \"*integer*\",\n \"3-2\": \"BlueSnap identifier for the refund.\"\n },\n \"cols\": 3,\n \"rows\": 6\n}\n[/block]","updates":[],"order":37,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f43d7db37d54d01d8ef0819","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":14,"from_sync":false,"reference":false,"_id":"5f43d7db37d54d01d8ef07d6","version":"5f43d7db37d54d01d8ef0876","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.35 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f43d7db37d54d01d8ef07cb","5f43d7db37d54d01d8ef07cc","5f43d7db37d54d01d8ef07cd","5f43d7db37d54d01d8ef07ce","5f43d7db37d54d01d8ef07cf","5f43d7db37d54d01d8ef07d0","5f43d7db37d54d01d8ef07d1","5f43d7db37d54d01d8ef07d2","5f43d7db37d54d01d8ef07d3","5f43d7db37d54d01d8ef07d4","5f43d7db37d54d01d8ef07d5","5f43d7db37d54d01d8ef07d6","5f43d7db37d54d01d8ef07d7","5f43d7db37d54d01d8ef07d8","5f43d7db37d54d01d8ef07d9","5f43d7db37d54d01d8ef07da","5f43d7db37d54d01d8ef07db","5f45521ec5bfe9005a858533"],"_id":"5f43d7db37d54d01d8ef0876","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5ed0377101fdb400214dedaa","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-09-23T16:54:49.971Z","githubsync":"","__v":0}refund
Contains refund details
Property Name
Type
Description
amount
decimal
Refund amount, positive value
currency
string
Currency of refund amount
date
string
Refund date
refundTransactionId
integer
BlueSnap identifier for the refund.
vendorAmount
decimal
The total vendor portion of the refund amount. Only available if one or more vendor IDs were included in original transaction.
