{"_id":"5c6c2407b8d4b2000e72da13","category":{"_id":"5c6c2407b8d4b2000e72d987","version":"5c6c2407b8d4b2000e72da25","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-08-19T11:04:31.283Z","from_sync":false,"order":6,"slug":"refunds","title":"Refunds"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"5c6c2407b8d4b2000e72da25","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5beec5a5f95d82011c6f3714","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5c6c2407b8d4b2000e72d981","5c6c2407b8d4b2000e72d982","5c6c2407b8d4b2000e72d983","5c6c2407b8d4b2000e72d984","5c6c2407b8d4b2000e72d985","5c6c2407b8d4b2000e72d986","5c6c2407b8d4b2000e72d987","5c6c2407b8d4b2000e72d988","5c6c2407b8d4b2000e72d989","5c6c2407b8d4b2000e72d98a","5c6c2407b8d4b2000e72d98b","5c6c2407b8d4b2000e72d98c","5c6c2407b8d4b2000e72d98d","5c6c2407b8d4b2000e72d98e","5c6c2407b8d4b2000e72d98f","5c6c2407b8d4b2000e72d990"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-XML","version":"8976-XML"},"githubsync":"","__v":11,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-12T17:43:39.621Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"language":"text","code":""}]},"settings":"","auth":"optional","params":[{"_id":"57b6ec9e49a12a0e007b469d","ref":"","in":"path","required":true,"desc":"ID of the transaction to be refunded","default":"","type":"string","name":"transaction-id"}],"url":"/transactions/:transaction-id/refund"},"isReference":false,"order":0,"body":"The Refund request enables you to perform a full or partial refund on a transaction that was processed through the Payment API. \n\nTo retrieve a transaction that has been refunded, use the [Retrieve Card Transaction](doc:retrieve), \n[Retrieve PayPal Transaction](doc:paypal-retrieve), [Retrieve ECP Transaction](doc:retrieve-ecp-transaction), or [Retrieve SEPA DD Transaction](doc:retrieve-sepa-dd-transaction) request.\n \n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Notes\",\n \"body\": \"* The refund is automatically performed in the currency that was used for the original transaction.\\n* For card and ACH transactions, if you issue a refund the same day as the initial transaction, the transaction is a void, rather than a refund.\\n* To view details about the refunds on a specific transaction, use the **Retrieve** call corresponding to the type of transaction (such as card or ECP).\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nEnter the transaction ID and any of the optional query parameters below into the request URL. For example:\n`services/2/transactions/1111111/refund?amount=9.20`\n\n**Query Parameters**\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter Name\",\n \"h-1\": \"Description\",\n \"h-2\": \"Example\",\n \"0-0\": \"`amount`\",\n \"1-0\": \"`reason`\",\n \"2-0\": \"`cancelsubscriptions`\",\n \"0-1\": \"*Optional*\\nAmount to be refunded, if this is a partial refund.\\nThe amount parameter value must be greater than 0 and no more than the total amount.\",\n \"1-1\": \"*Optional*\\nReason the shopper cancelled or requested a refund for the order. If this parameter is empty, the default string is \\\"Per your instructions\\\".\",\n \"2-1\": \"*Optional*\\n**Note**: Set to true if not passed.\\n**true** = (default) Cancel the shopper's subscription associated with this invoice ID. \\n**false** = Just refund the selected purchase and do not cancel the subscription.\",\n \"0-2\": \"`amount=9.20`\",\n \"1-2\": \"`reason=unsatisfied+customer`\",\n \"2-2\": \"`cancelsubscriptions=true`\",\n \"3-1\": \"*Optional*\\nAmount to be refunded to vendor. If no vendor amount parameters are passed, the transaction is refunded based on the original commission split.\\n\\n*Note:* Only used for Marketplace transactions with vendors when `amount` parameter is passed.\",\n \"3-0\": \"`vendor.{vendor ID}.amount`\",\n \"3-2\": \"`vendor.10398030.amount=4.10`\"\n },\n \"cols\": 3,\n \"rows\": 4\n}\n[/block]\n###Response Details\nIf successful, the response HTTP status code is 204 No Content.\nThere is no content in the response body.\n\n\n<hr>\n\n##Example\n\n###Request Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions/1111111/refund?amount=9.20 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n \"language\": \"curl\",\n \"name\": \"Refund Request\"\n }\n ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"HTTP/ 1.1 204 No Content\",\n \"language\": \"xml\",\n \"name\": \"Refund Response: 204 No Content\"\n }\n ]\n}\n[/block]\n<hr>\n\n##API Explorer\nTo test a call, enter an existing transaction ID in the `transaction-id` field. This automatically inserts the ID into the request URL. Leave the `Body Content` field empty.","excerpt":"","slug":"refund","type":"endpoint","title":"Refund"}putRefund
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
transaction-id:
required
string
ID of the transaction to be refunded
Documentation
The Refund request enables you to perform a full or partial refund on a transaction that was processed through the Payment API.
To retrieve a transaction that has been refunded, use the Retrieve Card Transaction,
Retrieve PayPal Transaction, Retrieve ECP Transaction, or Retrieve SEPA DD Transaction request.
Notes
- The refund is automatically performed in the currency that was used for the original transaction.
- For card and ACH transactions, if you issue a refund the same day as the initial transaction, the transaction is a void, rather than a refund.
- To view details about the refunds on a specific transaction, use the Retrieve call corresponding to the type of transaction (such as card or ECP).
Parameter Name
Description
Example
amount
Optional
Amount to be refunded, if this is a partial refund.
The amount parameter value must be greater than 0 and no more than the total amount.
amount=9.20
reason
Optional
Reason the shopper cancelled or requested a refund for the order. If this parameter is empty, the default string is "Per your instructions".
reason=unsatisfied+customer
cancelsubscriptions
Optional
Note: Set to true if not passed.
true = (default) Cancel the shopper's subscription associated with this invoice ID.
false = Just refund the selected purchase and do not cancel the subscription.
cancelsubscriptions=true
vendor.{vendor ID}.amount
Optional
Amount to be refunded to vendor. If no vendor amount parameters are passed, the transaction is refunded based on the original commission split.
Note: Only used for Marketplace transactions with vendors when amount parameter is passed.
vendor.10398030.amount=4.10
curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions/1111111/refund?amount=9.20 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d 'HTTP/ 1.1 204 No Content
