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.
Request Content
card-transaction container required, contains the following properties (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>
Example Description
Auth Reversal
The example above shows an Auth Reversal request, where the transaction ID received for the initial Auth Only for this transaction was 1011671985.
Auth Reversal with Merchant Transaction ID
The example above shows an Auth Reversal request, where the merchant transaction ID is being used instead of the transaction ID.
Back to Top
API Explorer
To test out a call, enter the XML portion of the request below and then click Try it!
Tip: Use the XML code below as a starting point. You can enter different parameters to see how your test scenario would work. The request headers, including authorization, are already built in for you in this test area, so you should not include them here.
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>AUTH_REVERSAL</card-transaction-type>
<transaction-id>1011671987</transaction-id>
</card-transaction>