{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/transactions","auth":"optional","examples":{"codes":[]},"method":"put","results":{"codes":[{"code":"","language":"text"}]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Auth Reversal","type":"endpoint","slug":"auth-reversal","excerpt":"","body":"Auth Reversal is a request that reverses, or voids, a previously approved authorization that has not yet been captured.\n\n**Note:** The reversal must be performed within 8 days of the initial Auth Only request, or else an error will occur. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Amount is not applicable to this request\",\n  \"body\": \"An Auth Reversal will void the entire transaction amount, so the `amount` property is not relevant.\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n`card-transaction` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, contains the following properties (see [card-transaction](doc:card-transaction)):\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`card-transaction-type` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, value must be **AUTH_REVERSAL**\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-id` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required if not using `merchant-transaction-id`**</span>, value must be the transaction ID you received in the [Auth Only](doc:auth-only) response for this transaction\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`merchant-transaction-id` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required if not using `transaction-id`**</span>, \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value must be the merchant transaction ID from the [Auth Only](doc:auth-only) response\n\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response will have the same content as the response to the initial [Auth Only](doc:auth-only) request, except that the value of the `card-transaction-type` resource will be **AUTH_REVERSAL**.\nThe `transaction-id` or `merchant-transaction-id` in the response will match the ID for the initial [Auth Only](doc:auth-only).\n\n<hr>\n\n##Example\n\n###Request Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_REVERSAL</card-transaction-type>\\n   <transaction-id>1011671987</transaction-id>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"Auth Reversal Request\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_REVERSAL</card-transaction-type>\\n   <merchant-transaction-id>1011671987</merchant-transaction-id>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with Merchant Transaction ID\"\n    }\n  ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>AUTH_REVERSAL</card-transaction-type>\\n  <transaction-id>1011671987</transaction-id>\\n  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>\\n  <amount>11.00</amount>\\n  <currency>USD</currency>\\n  <vaulted-shopper-id>1234</vaulted-shopper-id>\\n  <card-holder-info>\\n    <first-name>test first name</first-name>\\n    <last-name>test last name</last-name>\\n    <zip>123456</zip>\\n  </card-holder-info>\\n  <credit-card>\\n    <card-last-four-digits>0026</card-last-four-digits>\\n   <card-type>VISA</card-type>\\n   <card-sub-type>CREDIT</card-sub-type>\\n   <card-category>CLASSIC</card-category>\\n  </credit-card>\\n  <processing-info>\\n    <processing-status>SUCCESS</processing-status>\\n    <cvv-response-code>ND</cvv-response-code>\\n    <avs-response-code-zip>U</avs-response-code-zip>\\n    <avs-response-code-address>U</avs-response-code-address>\\n    <avs-response-code-name>U</avs-response-code-name>\\n  </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"Auth Reversal Response: 200 OK\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>AUTH_REVERSAL</card-transaction-type>\\n  <merchant-transaction-id>1011671987</transaction-id>\\n  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>\\n  <amount>11.00</amount>\\n  <currency>USD</currency>\\n  <vaulted-shopper-id>1234</vaulted-shopper-id>\\n  <card-holder-info>\\n    <first-name>test first name</first-name>\\n    <last-name>test last name</last-name>\\n    <zip>123456</zip>\\n  </card-holder-info>\\n  <credit-card>\\n    <card-last-four-digits>0026</card-last-four-digits>\\n   <card-type>VISA</card-type>\\n   <card-sub-type>CREDIT</card-sub-type>\\n   <card-category>CLASSIC</card-category>\\n  </credit-card>\\n  <processing-info>\\n    <processing-status>SUCCESS</processing-status>\\n    <cvv-response-code>ND</cvv-response-code>\\n    <avs-response-code-zip>U</avs-response-code-zip>\\n    <avs-response-code-address>U</avs-response-code-address>\\n    <avs-response-code-name>U</avs-response-code-name>\\n  </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"with Merchant Transaction ID\"\n    }\n  ]\n}\n[/block]\n<hr>\n\n##Example Description\n\n####Auth Reversal\nThe example above shows an Auth Reversal request, where the transaction ID received for the initial [Auth Only](doc:auth-only) for this transaction was **1011671985**.\n\n####Auth Reversal with Merchant Transaction ID\nThe example above shows an Auth Reversal request, where the merchant transaction ID is being used instead of the transaction ID.\n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, enter the XML portion of the request below and then click **Try it!**\n\n**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.*\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_REVERSAL</card-transaction-type>\\n   <transaction-id>1011671987</transaction-id>\\n</card-transaction>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61a5208deadb750070998ed8","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Card/Wallet Transactions","slug":"payment-transaction-service","order":1,"from_sync":false,"reference":true,"_id":"61a5208deadb750070998e88","version":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T15:28:41.796Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a5208deadb750070998e87","61a5208deadb750070998e88","61a5208deadb750070998e89","61a5208deadb750070998e8a","61a5208deadb750070998e8b","61a5208deadb750070998e8c","61a5208deadb750070998e8d","61a5208deadb750070998e8e","61a5208deadb750070998e8f","61a5208deadb750070998e90","61a5208deadb750070998e91","61a5208deadb750070998e92","61a5208deadb750070998e93","61a5208deadb750070998e94","61a5208deadb750070998e95","61a5208deadb750070998e96","61a5208deadb750070998e97","61a5208deadb750070998e98","61a5208deadb750070998e99","61a5208deadb750070998e9a"],"_id":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed269718a45001c25b4a0","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-01-12T16:47:24.121Z","githubsync":"","__v":0}

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

iDEAL Transactions

Local Bank Transfer transactions

SEPA Direct Debit Transactions

Sofort Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

putAuth Reversal

Definition

{{ api_url }}{{ page_api_url }}

Documentation

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

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

Auth Reversal Request
with Merchant Transaction ID
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

Auth Reversal Response: 200 OK
with Merchant Transaction ID
<?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&#x2a;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>123456</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&#x2a;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>123456</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.

XML
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_REVERSAL</card-transaction-type>
   <transaction-id>1011671987</transaction-id>
</card-transaction>

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}