{"id":"57336fd5a6a9c40e00e13a0b","name":"Developer Hub","subdomain":"bluesnap-developers","versions":[{"_id":"5b196f345952df0003e8a66c","releaseDate":"2018-04-24T15:22:41.561Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"2.1.16","version":"2.1.16"},{"_id":"5b1972b45952df0003e8a725","releaseDate":"2018-04-23T14:36:48.535Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"1.0.17","version":"1.0.17"},{"_id":"5b1973ec0059c20003083ec0","releaseDate":"2018-04-24T15:24:22.608Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"2.0.18","version":"2.0.18"},{"_id":"5b19742cb3baf90003cab5ae","releaseDate":"2018-04-24T15:33:45.744Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"3.0.16","version":"3.0.16"},{"_id":"5b197473be7bb50003d5dbd6","releaseDate":"2018-04-23T15:17:35.680Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"4.0.18","version":"4.0.18"},{"_id":"5b8ec56484303f0003a1145f","releaseDate":"2018-04-23T14:36:48.535Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"1.0.18","version":"1.0.18"},{"_id":"5b8ec5e884303f0003a114fb","releaseDate":"2018-04-24T15:22:41.561Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"2.1.17","version":"2.1.17"},{"_id":"5b8ec61584303f0003a1159b","releaseDate":"2018-04-24T15:24:22.608Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"2.0.19","version":"2.0.19"},{"_id":"5b8ec64c7ef0f4000350182a","releaseDate":"2018-04-23T15:17:35.680Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"4.0.19","version":"4.0.19"},{"_id":"5b8ec6a1f8dd7c0003386069","releaseDate":"2018-04-24T15:33:45.744Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"3.0.17","version":"3.0.17"},{"_id":"5bbf93937ef195000329c63e","releaseDate":"2018-04-23T14:36:48.535Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27.4 Release","version_clean":"1.0.19","version":"1.0.19"},{"_id":"5bc48b4f9919d4000df5ea7b","releaseDate":"2018-04-23T15:17:35.680Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27.4 Release","version_clean":"4.0.20","version":"4.0.20"},{"_id":"5bcf36ac4eaaa605217d94b8","releaseDate":"2018-04-24T15:22:41.561Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27.4 Release","version_clean":"2.1.18","version":"2.1.18"},{"_id":"5bcf37dfadc5b905136a39f4","releaseDate":"2018-04-24T15:24:22.608Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27.4 Release","version_clean":"2.0.20","version":"2.0.20"},{"_id":"5bcf3922e8455d049c357ed7","releaseDate":"2018-04-24T15:33:45.744Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.27.4 Release","version_clean":"3.0.18","version":"3.0.18"},{"_id":"5bdc633c15437b0042ed963c","releaseDate":"2018-04-23T15:17:35.680Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.29 Release","version_clean":"4.0.21","version":"4.0.21"},{"_id":"5beb278ac442ab0213f009cf","releaseDate":"2018-04-23T14:36:48.535Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.28 Release","version_clean":"1.0.20","version":"1.0.20"},{"_id":"5bedbcf19b49e8004462d199","releaseDate":"2018-04-24T15:33:45.744Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.29 Release","version_clean":"3.0.19","version":"3.0.19"},{"_id":"5bedd214812951004a2ad9df","releaseDate":"2018-04-24T15:22:41.561Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.29 Release","version_clean":"2.1.19","version":"2.1.19"},{"_id":"5beec5a5f95d82011c6f3714","releaseDate":"2018-04-24T15:24:22.608Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"3.29 Release","version_clean":"2.0.21","version":"2.0.21"},{"_id":"5c6c238ff7d54800395355a0","releaseDate":"2018-04-23T14:36:48.535Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Main","version_clean":"8976.0.0-Basics","version":"8976-Basics"},{"_id":"5c6c23e4735b81006177d0a4","releaseDate":"2018-04-24T15:22:41.561Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},{"_id":"5c6c2407b8d4b2000e72da25","releaseDate":"2018-04-24T15:24:22.608Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-XML","version":"8976-XML"},{"_id":"5c6c245bc0d91f0185a7409c","releaseDate":"2018-04-23T15:17:35.680Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-Tools","version":"8976-Tools"},{"_id":"5c742637ad58c70033b9c762","releaseDate":"2018-04-24T15:33:45.744Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-Extended","version":"8976-Extended"}],"current_version":{"version_clean":"8976.0.0-JSON","version":"8976-JSON"},"oauth":{"enabled":false},"api":{"name":"","url":"https://sandbox.bluesnap.com/services/2","contenttype":"body","auth":"basic","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[{"_id":"561b9fceab412a0d004d8631","type":"header","default":"Basic QVBJXzE0NDQ2NTAyMDMxNDQ5NDA0MjIzNjU6QkxVRTEyMw==","key":"Authorization"}],"headers":[{"_id":"561c03a2eaf4852b00a46771","value":"Application/XML","key":"content-type"},{"_id":"56f12a866d8030220001ef98","value":"2.0","key":"bluesnap-version"}],"object_definitions":[]},"apiAlt":[{"_id":"57ee593a21ceb20e0061959e","object_definitions":[],"headers":[{"_id":"57ee59b33b369f0e00469e40","value":"application/json","key":"content-type"},{"_id":"57ee59b33b369f0e00469e3f","value":"application/json","key":"accept"},{"_id":"57ee672b21ceb20e006195a4","value":"2.0","key":"bluesnap-version"}],"authextra":[{"_id":"57ee59b33b369f0e00469e3e","type":"header","default":"Basic QVBJXzE0NDQ2NTAyMDMxNDQ5NDA0MjIzNjU6QkxVRTEyMw==","key":"Authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"basic","contenttype":"body","url":"https://sandbox.bluesnap.com/services/2","name":"JSON"}],"plan_details":{"name":"Business","is_active":true,"cost":199,"versions":10000,"custom_domain":true,"custom_pages":true,"whitelabel":true,"errors":true,"password":true,"landing_page":true,"stylesheet":true,"javascript":true,"html":true,"extra_html":true,"admins":true},"intercom":"","intercom_secure_emailonly":false,"flags":{"allow_hub2":false,"hub2":false,"migrationRun":true,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":true,"allowXFrame":false,"jwt":false,"hideGoogleAnalytics":false,"stripe":false,"disableDiscuss":false,"newApiExplorer":false},"asset_base_url":""}
{"_id":"5c6c23e4735b81006177d01f","category":{"_id":"5c6c23e4735b81006177d00b","version":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-08-19T11:04:31.283Z","from_sync":false,"order":5,"slug":"refunds","title":"Refunds"},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"_id":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"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":"57ee593a21ceb20e0061959e","auth":"optional","params":[{"_id":"57b6ec9e49a12a0e007b469d","ref":"","in":"path","required":true,"desc":"ID of the transaction to be refunded","default":"","type":"string","name":"transactionId"}],"url":"/transactions/:transactionId/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\": \"Requirements\",\n  \"body\": \"The refund will automatically be performed in the currency that was used for the original transaction.\"\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**true** = 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\": \"`cancelsubscription=true`\",\n    \"3-0\": \"`vendor.{vendor ID}.amount`\",\n    \"3-1\": \"*Optional*\\nAmount to be refunded to vendor. If no vendor amount parameters are passed, the transaction will be refunded based on the original commission split.\\n\\n*Note:* Only used for Marketplace transactions with vendors when `amount` parameter is passed.\",\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[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"To view details about the refunds on a specific transaction, retrieve the transaction as described in [Retrieve Card Transaction](doc:retrieve) and [Retrieve PayPal Transaction](doc:paypal-retrieve).\",\n  \"title\": \"Refund details appear in retrieved transactions\"\n}\n[/block]\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/json' \\\\\\n-H 'Accept: application/json' \\\\ \\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\": \"json\",\n      \"name\": \"Refund Response: 204 No Content\"\n    }\n  ]\n}\n[/block]\n<hr>\n\n##API Explorer\nTo test out a call, enter an existing transaction ID in the `transactionId` field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.","excerpt":"","slug":"refund","type":"endpoint","title":"Refund"}

Payment API (JSON)

Amazon Guess Amazon Serenella Overall Amazon Serenella Neri Neri Guess Serenella Overall Guess Overall pLVqzGSUM

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

Amazon Guess Amazon Serenella Overall Amazon Serenella Neri Neri Guess Serenella Overall Guess Overall pLVqzGSUM

JSON Objects

Test Data & Codes

  • Test Card Numbers
  • AVS Response Codes
  • Country Codes
  • Credit Card Codes
  • Currency Codes
  • CVV Response Codes
  • State and Province Codes

Guides & Tools

  • 3D Secure Guide
  • Account Updater
  • ACH/ECP
  • Apple Pay Guide
  • Batch Processing Guide (XML)
  • Card on File Guide
  • Client-side Encryption
  • Embedded Checkout
  • Fraud Prevention
  • Google Pay Guide
  • Hosted Payment Fields
  • Hosted Payment Page
  • IPNs (Webhooks)
  • LATAM Local Processing
  • Level 2/3 Data Guide
  • Masterpass Guide
  • Metadata Guide
  • Payment Request API (W3C) Guide
  • PayPal GuideMecshopping Midi Con Lurex Aderente Neri Vestito BxWdCero
  • Reporting API
  • Retrieving Card Info
  • Returning Shoppers Guide
  • SEPA Direct Debit Guide
  • Statement Descriptor
  • Subscriptions Guide
  • Visa Checkout Guide

Mobile SDK


Definition

{{ api_url }} {{ page_api_url }}

Parameters


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.

Requirements Amazon Guess Amazon Serenella Overall Amazon Serenella Neri Neri Guess Serenella Overall Guess Overall pLVqzGSUM

The refund will automatically be performed in the currency that was used for the original transaction.

Try it in the API Explorer

Request Content

Enter the transaction ID and any of the optional query parameters below into the request URL. For example:
services/2/transactions/1111111/refund?amount=9.20CalzatureNeri CalzatureNeri CalzatureNeri Mally Mally Fibbia Fibbia Fibbia Mally Mally Mally CalzatureNeri CalzatureNeri Fibbia CsQdrht

Query Parameters

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.

Pullover MaglieriaViola Allude MaglieriaViola Pullover Allude MaglieriaViola Allude Pullover Allude Pullover MaglieriaViola wkuTPXiOZ

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

Amazon Guess Amazon Serenella Overall Amazon Serenella Neri Neri Guess Serenella Overall Guess Overall pLVqzGSUM

cancelsubscriptions

Optional
true = Cancel the shopper's subscription associated with this invoice ID.
false = Just refund the selected purchase and do not cancel the subscription.

cancelsubscription=true

vendor.{vendor ID}.amount

Optional
Amount to be refunded to vendor. If no vendor amount parameters are passed, the transaction will be refunded based on the original commission split.

Note: Only used for Marketplace transactions with vendors when amount parameter is passed.

Amazon Guess Amazon Serenella Overall Amazon Serenella Neri Neri Guess Serenella Overall Guess Overall pLVqzGSUM

vendor.10398030.amount=4.10

Response Details

If successful, the response HTTP status code is 204 No Content.
There is no content in the response body.

Refund details appear in retrieved transactions

To view details about the refunds on a specific transaction, retrieve the transaction as described in Retrieve Card Transaction and Retrieve PayPal TransactionDress Boohoo Plus Strappy Maxi Slinky Lunghi Beige H2IDE9.


Example

Request Example

Refund Request
																		
																			
																				curl
																				-v
																				-X
																				PUT https://sandbox.bluesnap.com/services/2/transactions/1111111/refundGiacca Adventure Pile 2 Neri moto Bianco Nero Fc Scott L erxCodB?amount
																				=
																				9.20 \
																				-H
																				'Content-Type: application/json'
																				\
																				-H
																				'Accept: application/json'
																				\
																				-H
																				'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
																				\
																				-d
																				'
																			
																		
																	

Response Example

Refund Response: 204 No Content
																		
																			
																				HTTP
																				/
																				1.1Amazon Guess Amazon Serenella Overall Amazon Serenella Neri Neri Guess Serenella Overall Guess Overall pLVqzGSUM
																				
																				204
																				No
																				Content
																			
																		
																	
Amazon Guess Amazon Serenella Overall Amazon Serenella Neri Neri Guess Serenella Overall Guess Overall pLVqzGSUM


API Explorer

To test out a call, enter an existing transaction ID in the transactionId field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.


User Information

Try It Out


put
{{ tryResults.results }}
Amazon Guess Amazon Serenella Overall Amazon Serenella Neri Neri Guess Serenella Overall Guess Overall pLVqzGSUM
Eric Primavera 3290 calzature Giallo Sneakers Uomo Galeotti Premiata BeCdxo
Method {{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL {{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}
Amazon Guess Amazon Serenella Overall Amazon Serenella Neri Neri Guess Serenella Overall Guess Overall pLVqzGSUM