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.
Send a test request
Go to API Explorer to send a test request to our sandbox environment and receive a response in real time.
Request Content
Send a cardTransaction object, with the following:
| Property | Type | Required |
|---|---|---|
cardTransactionType | string | required, value must be AUTH_REVERSAL |
merchantTransactionId | string | required if not using transactionIdvalue must be the merchant transaction ID from the Auth Only response |
transactionId | string | required if not using merchantTransactionIdvalue must be the transaction ID from the Auth Only response |
Note
If both
transactionIdandmerchantTransactionIdare included,merchantTransactionIdwill 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
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
}'
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
{
"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
}
{
"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
}
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.