{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"refunds","type":"basic","slug":"refunds","excerpt":"Contains existing refunds for this transaction","body":"###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\": \"`refund`\",\n    \"0-1\": \"container\",\n    \"0-2\": \"Container of [refund](doc:refund-1) properties.\\nMay appear multiple times within this resource.\",\n    \"1-0\": \"`balance-amount`\",\n    \"2-0\": \"`vendor-balance-amount`\",\n    \"1-1\": \"*decimal*\",\n    \"2-1\": \"*decimal*\",\n    \"1-2\": \"Amount available to be refunded\",\n    \"2-2\": \"Amount available to be refunded to vendors. Only applicable if one or more vendors were involved in original transaction.\",\n    \"3-0\": \"`vendors-balance-info`\",\n    \"3-1\": \"container\",\n    \"3-2\": \"Container of [vendors-balance-info](doc:vendors-balance-info) properties.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","updates":[],"order":42,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ed5174637c3c607440c09c3","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":14,"from_sync":false,"reference":false,"_id":"5ed5174637c3c607440c0997","version":"5ed5174637c3c607440c0a3c","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.34.0 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ed5174637c3c607440c098b","5ed5174637c3c607440c098c","5ed5174637c3c607440c098d","5ed5174637c3c607440c098e","5ed5174637c3c607440c098f","5ed5174637c3c607440c0990","5ed5174637c3c607440c0991","5ed5174637c3c607440c0992","5ed5174637c3c607440c0993","5ed5174637c3c607440c0994","5ed5174637c3c607440c0995","5ed5174637c3c607440c0996","5ed5174637c3c607440c0997","5ed5174637c3c607440c0998","5ed5174637c3c607440c0999","5ed5174637c3c607440c099a","5ed5174637c3c607440c099b","5ed5174637c3c607440c099c"],"_id":"5ed5174637c3c607440c0a3c","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5e5d3a02fb6fb40050cb3c15","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-09-21T18:19:03.783Z","githubsync":"","__v":0}

refunds

Contains existing refunds for this transaction

Request

N/A

Response

Property Name
Type
Description

refund

container

Container of refund properties.
May appear multiple times within this resource.

balance-amount

decimal

Amount available to be refunded

vendor-balance-amount

decimal

Amount available to be refunded to vendors. Only applicable if one or more vendors were involved in original transaction.

vendors-balance-info

container

Container of vendors-balance-info properties.