The Refund request allows you to perform a full or partial refund on a transaction that was processed through the Payment API.
Notes
Refund currency The refund is automatically performed in the currency of the original transaction.
Refunds for card and ACH transactions For card and ACH transactions, when you issue a refund, we will first attempt to void the transaction.
- For cards, if the transaction cannot be voided, a refund will be issued.
- For ACH, you will need to issue a refund once the transaction has been settled.
Retrieving refund details To view details about the refunds on a specific transaction, use the Retrieve call for that transaction type (such as Retrieve Card Transaction or Retrieve ACH/ECP Transaction).
- Retrieve the transaction using the
transaction-idto view all refunds for that transaction.- Retrieve the transaction using the
refund-transaction-idto view a specific refund and all its details (such as metadata).Colorado Delivery Fee: Per Colorado tax law, the Colorado delivery fee is not refundable except for cancelled, chargeback or voided transactions. This includes the tax portion except in the case of certain chargebacks.
Tip
You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.
Request Content
Send a refund object, with the following:
Property | Type | Required |
|---|---|---|
| decimal | optional |
| decimal | optional (included if a partial refund of transaction involving taxes) |
| string | optional |
| boolean | optional |
| container | optional (see vendors-refund-info) |
| container | optional (see transaction-meta-data) |
Response Details
If successful, the response HTTP status code is 200 and contains the refund object.
Example
Request Example
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions/refund/1039318399 \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<refund xmlns="http://ws.plimus.com">
<reason>Refund for order #1992</reason>
<cancel-subscriptions>false</cancel-subscriptions>
<transaction-meta-data>
<meta-data>
<meta-key>refundedItems</meta-key>
<meta-value>1552,8832</meta-value>
<meta-description>Refunded Items</meta-description>
</meta-data>
<meta-data>
<meta-key>keyNumber2</meta-key>
<meta-value>KTD</meta-value>
<meta-description>Metadata 2</meta-description>
</meta-data>
</transaction-meta-data>
</refund>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions/refund/1039287997 \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<refund xmlns="http://ws.plimus.com">
<amount>10</amount>
<cancel-subscriptions>false</cancel-subscriptions>
</refund>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions/refund/1039287997 \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<refund xmlns="http://ws.plimus.com">
<amount>52.50</amount>
<tax-amount>2.50</tax-amount>
</refund>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions/refund/merchant/1011671987 \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<refund xmlns="http://ws.plimus.com">
<reason>Refund for order #1992</reason>
</refund>'
Response Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<refund xmlns="http://ws.plimus.com">
<refund-transaction-id>1039318651</refund-transaction-id>
<transaction-meta-data>
<meta-data>
<meta-key>refundedItems</meta-key>
<meta-value>1552,8832</meta-value>
<meta-description>Refunded Items</meta-description>
</meta-data>
<meta-data>
<meta-key>keyNumber2</meta-key>
<meta-value>KTD</meta-value>
<meta-description>Metadata 2</meta-description>
</meta-data>
</transaction-meta-data>
<reason>Refund for order #1992</reason>
<cancel-subscriptions>false</cancel-subscriptions>
</refund>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<refund xmlns="http://ws.plimus.com">
<refund-transaction-id>1039318669</refund-transaction-id>
<amount>10</amount>
<cancel-subscriptions>false</cancel-subscriptions>
</refund>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<refund xmlns="http://ws.plimus.com">
<refund-transaction-id>1039318670</refund-transaction-id>
<amount>52.50</amount>
<tax-amount>2.50</tax-amount>
</refund>
API Explorer
To test a call, enter an existing transaction ID in the transaction-id field. This automatically inserts the ID into the request URL. Click the "Try It!" button in the right-hand column to test using the default, pre-populated sample values. To test with your own values, edit the parameter fields below. You'll see them populate in the right-hand column and you can click the "Try It!" button to submit your test request and see a response.