Auth Reversal is a request that reverses, or voids, a previously approved authorization that has not yet been captured.
Note: The reversal must be performed within 8 days of the initial Auth Only request, or else an error will occur.
Amount is not applicable to this request
An Auth Reversal will void the entire transaction amount, so the
amountproperty is not relevant.
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
| Property | Type | Required |
|---|---|---|
card-transaction | container | required, contains the properties below (see card-transaction): |
card-transaction-type | string | required, value must be AUTH_REVERSAL |
transaction-id | string | required if not using merchant-transaction-id, value must be the transaction ID you received in the Auth Only response for this transaction |
merchant-transaction-id | string | required if not using transaction-id, value must be the merchant transaction ID from the Auth Only response |
Response Details
If successful, the response HTTP status code is 200 OK.
The response will have the same content as the response to the initial Auth Only request, except that the value of the card-transaction-type resource will be AUTH_REVERSAL.
The transaction-id or merchant-transaction-id in the response will match the ID for the initial Auth Only.
Example
Request Example
curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>AUTH_REVERSAL</card-transaction-type>
<transaction-id>1011671987</transaction-id>
</card-transaction>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>AUTH_REVERSAL</card-transaction-type>
<merchant-transaction-id>1011671987</merchant-transaction-id>
</card-transaction>'
Response Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>AUTH_REVERSAL</card-transaction-type>
<transaction-id>1011671987</transaction-id>
<soft-descriptor>BLS*DescTest</soft-descriptor>
<amount>11.00</amount>
<currency>USD</currency>
<vaulted-shopper-id>1234</vaulted-shopper-id>
<card-holder-info>
<first-name>test first name</first-name>
<last-name>test last name</last-name>
<zip>02453</zip>
</card-holder-info>
<credit-card>
<card-last-four-digits>0026</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
<card-category>CLASSIC</card-category>
</credit-card>
<processing-info>
<processing-status>SUCCESS</processing-status>
<cvv-response-code>ND</cvv-response-code>
<avs-response-code-zip>U</avs-response-code-zip>
<avs-response-code-address>U</avs-response-code-address>
<avs-response-code-name>U</avs-response-code-name>
</processing-info>
</card-transaction>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>AUTH_REVERSAL</card-transaction-type>
<merchant-transaction-id>1011671987</transaction-id>
<soft-descriptor>BLS*DescTest</soft-descriptor>
<amount>11.00</amount>
<currency>USD</currency>
<vaulted-shopper-id>1234</vaulted-shopper-id>
<card-holder-info>
<first-name>test first name</first-name>
<last-name>test last name</last-name>
<zip>02453</zip>
</card-holder-info>
<credit-card>
<card-last-four-digits>0026</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
<card-category>CLASSIC</card-category>
</credit-card>
<processing-info>
<processing-status>SUCCESS</processing-status>
<cvv-response-code>ND</cvv-response-code>
<avs-response-code-zip>U</avs-response-code-zip>
<avs-response-code-address>U</avs-response-code-address>
<avs-response-code-name>U</avs-response-code-name>
</processing-info>
</card-transaction>
API Explorer
To test out a basic API request, 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.