{"_id":"5bcf37dfadc5b905136a398b","category":{"_id":"5bcf37dfadc5b905136a395e","version":"5bcf37dfadc5b905136a39f4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5bcf37dfadc5b905136a39f4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b8ec61584303f0003a1159b","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5bcf37dfadc5b905136a3952","5bcf37dfadc5b905136a3953","5bcf37dfadc5b905136a3954","5bcf37dfadc5b905136a3955","5bcf37dfadc5b905136a3956","5bcf37dfadc5b905136a3957","5bcf37dfadc5b905136a3958","5bcf37dfadc5b905136a3959","5bcf37dfadc5b905136a395a","5bcf37dfadc5b905136a395b","5bcf37dfadc5b905136a395c","5bcf37dfadc5b905136a395d","5bcf37dfadc5b905136a395e","5bcf37dfadc5b905136a395f","5bcf37dfadc5b905136a3960","5bcf37dfadc5b905136a3961"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27.2 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-21T18:18:12.294Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":36,"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\": \"`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\": \"`vendor-amount`\",\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\": \"`vendors-refund-info`\",\n    \"5-1\": \"container\",\n    \"5-2\": \"Container of [vendors-refund-info](doc:vendors-refund-info) properties.\",\n    \"3-0\": \"`refund-transaction-id`\",\n    \"3-1\": \"*integer*\",\n    \"3-2\": \"BlueSnap identifier for the refund.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","excerpt":"Contains refund details","slug":"refund-1","type":"basic","title":"refund"}

refund

Contains refund details

Request

N/A

Response

Property Name
Type
Description

amount

decimal

Refund amount, positive value

currency

string

Currency of refund amount

date

string

Refund date

refund-transaction-id

integer

BlueSnap identifier for the refund.

vendor-amount

decimal

The total vendor portion of the refund amount. Only available if one or more vendor IDs were included in original transaction.

vendors-refund-info

container

Container of vendors-refund-info properties.