{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"refund","type":"basic","slug":"refund-1","excerpt":"Contains refund details","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`amount`\",\n    \"0-1\": \"*decimal*\",\n    \"0-2\": \"Optional\",\n    \"0-3\": \"Amount to be refunded, if this is a partial refund.\\n\\nValue must be greater than 0 and must not exceed the total transaction amount.\",\n    \"2-0\": \"`reason`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Reason the shopper cancelled or requested a refund for the order. \\n\\nDefault value is \\\"Per your instructions\\\". \\n\\nMaximum 4000 characters.\",\n    \"3-0\": \"`cancel-subscriptions`\",\n    \"3-1\": \"*boolean*\",\n    \"3-2\": \"Optional\",\n    \"3-3\": \"Whether to cancel the subscription associated with the transaction ID. \\n\\nValues: \\n**true** (default) - Cancel the subscription and refund the charge\\n**false** - Do not cancel the subscription. Just refund the charge.\",\n    \"4-0\": \"`vendors-refund-info`\",\n    \"4-1\": \"container\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"Only applicable to partial refunds (if `amount` was passed). Contains the details about the Marketplace vendors' portion of the refund. \\n\\nRefer to [vendors-refund-info](doc:vendors-refund-info).\",\n    \"5-0\": \"`transactionMetaData`\",\n    \"5-1\": \"container\",\n    \"5-2\": \"Optional\",\n    \"5-3\": \"Container of [transaction-meta-data](doc:transaction-meta-data) properties.\",\n    \"1-0\": \"`tax-amount`\",\n    \"1-1\": \"*decimal*\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"Tax amount to be refunded, if this is a partial refund. Remember to also specify the total refund amount (including tax) in the `amount` parameter. See the [Taxes guide](https://developers.bluesnap.com/v8976-Basics/docs/taxes) for more details.\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\n}\n[/block]\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    \"2-0\": \"`currency`\",\n    \"3-0\": \"`date`\",\n    \"2-1\": \"*string*\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"Refund date\",\n    \"2-2\": \"Currency of refund amount\",\n    \"5-0\": \"`vendor-amount`\",\n    \"5-1\": \"*decimal*\",\n    \"5-2\": \"The total vendor portion of the refund amount. Only available if one or more vendor IDs were included in original transaction.\",\n    \"6-0\": \"`vendors-refund-info`\",\n    \"6-1\": \"container\",\n    \"6-2\": \"Container of [vendors-refund-info](doc:vendors-refund-info) properties.\",\n    \"4-0\": \"`refund-transaction-id`\",\n    \"4-1\": \"*integer*\",\n    \"4-2\": \"BlueSnap identifier for the refund.\",\n    \"7-0\": \"`transaction-meta-data`\",\n    \"7-1\": \"container\",\n    \"7-2\": \"Container of [transaction-meta-data](doc:transaction-meta-data) properties.\",\n    \"8-0\": \"`reason`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Reason the shopper cancelled or requested a refund for the order.\",\n    \"9-0\": \"`cancel-subscriptions`\",\n    \"9-1\": \"*boolean*\",\n    \"9-2\": \"Whether to cancel the subscription associated with the transaction ID.\",\n    \"1-0\": \"`tax-amount`\",\n    \"1-1\": \"*decimal*\",\n    \"1-2\": \"The tax amount that was refunded\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]","updates":[],"order":44,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60fed269718a45001c25b419","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"60fed269718a45001c25b3ec","version":"60fed269718a45001c25b4a0","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.39 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60fed269718a45001c25b3e0","60fed269718a45001c25b3e1","60fed269718a45001c25b3e2","60fed269718a45001c25b3e3","60fed269718a45001c25b3e4","60fed269718a45001c25b3e5","60fed269718a45001c25b3e6","60fed269718a45001c25b3e7","60fed269718a45001c25b3e8","60fed269718a45001c25b3e9","60fed269718a45001c25b3ea","60fed269718a45001c25b3eb","60fed269718a45001c25b3ec","60fed269718a45001c25b3ed","60fed269718a45001c25b3ee","60fed269718a45001c25b3ef","60fed269718a45001c25b3f0","60fed269718a45001c25b3f1","60fed269718a45001c25b3f2","60fed269718a45001c25b3f3"],"_id":"60fed269718a45001c25b4a0","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60a664e29be3b00016c6d151","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-09-21T18:18:12.294Z","githubsync":"","__v":0}

refund

Contains refund details

Request

Property Name
Type
Required
Description

amount

decimal

Optional

Amount to be refunded, if this is a partial refund.

Value must be greater than 0 and must not exceed the total transaction amount.

tax-amount

decimal

Optional

Tax amount to be refunded, if this is a partial refund. Remember to also specify the total refund amount (including tax) in the amount parameter. See the Taxes guide for more details.

reason

string

Optional

Reason the shopper cancelled or requested a refund for the order.

Default value is "Per your instructions".

Maximum 4000 characters.

cancel-subscriptions

boolean

Optional

Whether to cancel the subscription associated with the transaction ID.

Values:
true (default) - Cancel the subscription and refund the charge
false - Do not cancel the subscription. Just refund the charge.

vendors-refund-info

container

Optional

Only applicable to partial refunds (if amount was passed). Contains the details about the Marketplace vendors' portion of the refund.

Refer to vendors-refund-info.

transactionMetaData

container

Optional

Container of transaction-meta-data properties.

Response

Property Name
Type
Description

amount

decimal

Refund amount, positive value

tax-amount

decimal

The tax amount that was refunded

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.

transaction-meta-data

container

Container of transaction-meta-data properties.

reason

string

Reason the shopper cancelled or requested a refund for the order.

cancel-subscriptions

boolean

Whether to cancel the subscription associated with the transaction ID.