{"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    \"3-0\": \"`vendor-balance-amount`\",\n    \"1-1\": \"*decimal*\",\n    \"3-1\": \"*decimal*\",\n    \"1-2\": \"Amount available to be refunded\",\n    \"3-2\": \"Amount available to be refunded to vendors. Only applicable if one or more vendors were involved in original transaction.\",\n    \"4-0\": \"`vendors-balance-info`\",\n    \"4-1\": \"container\",\n    \"4-2\": \"Container of [vendors-balance-info](doc:vendors-balance-info) properties.\",\n    \"2-0\": \"`tax-balance-amount`\",\n    \"2-1\": \"*decimal*\",\n    \"2-2\": \"The tax amount available to be refunded, if taxes were part of the transaction.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","updates":[],"order":45,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"603d5be8af8f1a0061138135","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"603d5be8af8f1a0061138107","version":"603d5be8af8f1a00611381ba","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.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["603d5be8af8f1a00611380fb","603d5be8af8f1a00611380fc","603d5be8af8f1a00611380fd","603d5be8af8f1a00611380fe","603d5be8af8f1a00611380ff","603d5be8af8f1a0061138100","603d5be8af8f1a0061138101","603d5be8af8f1a0061138102","603d5be8af8f1a0061138103","603d5be8af8f1a0061138104","603d5be8af8f1a0061138105","603d5be8af8f1a0061138106","603d5be8af8f1a0061138107","603d5be8af8f1a0061138108","603d5be8af8f1a0061138109","603d5be8af8f1a006113810a","603d5be8af8f1a006113810b","603d5be8af8f1a006113810c","603d5be8af8f1a006113810d","603d5be8af8f1a006113810e"],"_id":"603d5be8af8f1a00611381ba","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5ff4b747849e1b03c50684c7","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

tax-balance-amount

decimal

The tax amount available to be refunded, if taxes were part of the transaction.

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.