Auth Reversal

POST https://sandbox.bluesnap.com/services/2/transactions

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 amount property is not relevant.

Try it in the API Explorer

Request Content

Send a cardTransaction object, with the following:

      cardTransactionType     string    required, value must be AUTH_REVERSAL
     transactionId     string    required if not using merchantTransactionId,
     value must be the transaction ID from the Auth Only response
     merchantTransactionId     string    required if not using transactionId,
     value must be the merchant transaction ID from the Auth Only response

Note: If both transactionId and merchantTransactionId are included, merchantTransactionId will be ignored.

---

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 cardTransactionType will be AUTH_REVERSAL. The transactionId or 'merchantTransactionId' in the response will match the ID for the initial Auth Only.

---

Example

Request Example

Auth Reversal Request

curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "cardTransactionType": "AUTH_REVERSAL",
    "transactionId": 1011671987
}'

with Merchant Transaction ID

curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

{ 
   "cardTransactionType": "AUTH_REVERSAL",
   "merchantTransactionId": 1011671987 
} '

Response Example

Auth Reversal Response: 200 OK

{
    "amount": 11,
    "vaultedShopperId": 1234,
    "processingInfo": {
        "avsResponseCodeAddress": "U",
        "processingStatus": "SUCCESS",
        "cvvResponseCode": "ND",
        "avsResponseCodeName": "U",
        "avsResponseCodeZip": "U"
    },
    "softDescriptor": "BLS*DescTest",
    "cardHolderInfo": {
        "firstName": "test first name",
        "lastName": "test last name",
      	"zip": "02453"
    },
    "currency": "USD",
    "creditCard": {
        "cardLastFourDigits": "0026",
        "cardSubType": "CREDIT",
        "cardType": "VISA",
      	"cardCategory": "CLASSIC"
    },
    "cardTransactionType": "AUTH_REVERSAL",
    "transactionId": 1011671987
}

with Merchant Transaction ID

{
    "amount": 11,
    "vaultedShopperId": 1234,
    "processingInfo": {
        "avsResponseCodeAddress": "U",
        "processingStatus": "SUCCESS",
        "cvvResponseCode": "ND",
        "avsResponseCodeName": "U",
        "avsResponseCodeZip": "U"
    },
    "softDescriptor": "BLS*DescTest",
    "cardHolderInfo": {
        "firstName": "test first name",
        "lastName": "test last name",
      	"zip": "123456"
    },
    "currency": "USD",
    "creditCard": {
        "cardLastFourDigits": "0026",
        "cardSubType": "CREDIT",
        "cardType": "VISA",
      	"cardCategory": "CLASSIC"
    },
    "cardTransactionType": "AUTH_REVERSAL",
    "merchantTransactionId": 1011671987
}

---

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 request content below and then click Try it!

Tip: Use the JSON 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.

JSON

{
    "cardTransactionType": "AUTH_REVERSAL",
    "transactionId": 1011671987
}