{"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":"###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    \"1-0\": \"`reason`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"Reason the shopper cancelled or requested a refund for the order. \\n\\nDefault value is \\\"Per your instructions\\\". \\n\\nMaximum 4000 characters.\",\n    \"2-0\": \"`cancelSubscriptions`\",\n    \"2-1\": \"*boolean*\",\n    \"2-2\": \"Optional\",\n    \"2-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    \"3-0\": \"`vendorsRefundInfo`\",\n    \"3-1\": \"*object*\",\n    \"3-2\": \"Optional\",\n    \"3-3\": \"Only applicable to partial refunds (if `amount` was passed). Contains the details about the Marketplace vendors' portion of the refund. \\n\\nSee [vendorsRefundInfo](doc:vendorsrefundinfo).\",\n    \"4-0\": \"`transactionMetaData`\",\n    \"4-1\": \"*object*\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"See [transactionMetaData](doc:transaction-meta-data).\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]\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    \"6-0\": \"`transactionMetaData`\",\n    \"6-1\": \"*object*\",\n    \"6-2\": \"See [transactionMetaData](doc:transaction-meta-data).\",\n    \"7-0\": \"`reason`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"Reason the shopper cancelled or requested a refund for the order.\",\n    \"8-0\": \"`cancelSubscriptions`\",\n    \"8-1\": \"*boolean*\",\n    \"8-2\": \"Whether to cancel the subscription associated with the transaction ID.\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]","updates":[],"order":38,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ff39c12e2e8fa00503ad57c","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":15,"from_sync":false,"reference":false,"_id":"5ff39c12e2e8fa00503ad538","version":"5ff39c12e2e8fa00503ad5e4","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.36.1 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ff39c12e2e8fa00503ad52d","5ff39c12e2e8fa00503ad52e","5ff39c12e2e8fa00503ad52f","5ff39c12e2e8fa00503ad530","5ff39c12e2e8fa00503ad531","5ff39c12e2e8fa00503ad532","5ff39c12e2e8fa00503ad533","5ff39c12e2e8fa00503ad534","5ff39c12e2e8fa00503ad535","5ff39c12e2e8fa00503ad536","5ff39c12e2e8fa00503ad537","5ff39c12e2e8fa00503ad538","5ff39c12e2e8fa00503ad539","5ff39c12e2e8fa00503ad53a","5ff39c12e2e8fa00503ad53b","5ff39c12e2e8fa00503ad53c","5ff39c12e2e8fa00503ad53d","5ff39c12e2e8fa00503ad53e","5ff39c12e2e8fa00503ad53f"],"_id":"5ff39c12e2e8fa00503ad5e4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fc6c6094cb8fa066b0d2ea3","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

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.

reason

string

Optional

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

Default value is "Per your instructions".

Maximum 4000 characters.

cancelSubscriptions

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.

vendorsRefundInfo

object

Optional

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

See vendorsRefundInfo.

transactionMetaData

object

Optional

Response

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.

vendorsRefundInfo

object

transactionMetaData

object

reason

string

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

cancelSubscriptions

boolean

Whether to cancel the subscription associated with the transaction ID.