{"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\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]","updates":[],"order":41,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ed5174637c3c607440c09c2","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},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","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:18:12.294Z","githubsync":"","__v":0}

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Local Bank Transfer transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

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.