Skip to main content

5.4 Reversal

5.4.1 Reverse or void an authorization (CCREVERSE).​

The merchant can request that an authorization be voided by sending CCREVERSE in the request_action parameter.

NOTE: a successful void prevents a charge and a subsequent refund, avoiding fees.

The following shows the parameters used in the Token request.

5.4.1

Important Note

Partial amount reversals are not accepted by all banks. Please contact customer service before implementing partial amount requests.

5.4.2 CREDIT_ON_FAIL Flag​

In the event that the reversal request has failed, the system can attempt an automatic refund without requiring the merchant to send a separate request. To enable this feature, set the CREDIT_ON_FAIL parameter to "1" and send this parameter with the CCREVERSE request.

Set this value to null to disable it.

5.4.2

The merchant should expect a CCREVERSE response if the reversal request is successful; if unsuccessful, the API will return a CCCREDIT response instead.

5.4.2.1 Successful CCREVERSE Response Example​

<RESPONSE>
    <REQUEST_ACTION>CCREVERSE</REQUEST_ACTION>
    <TRANS_STATUS_NAME>APPROVED</TRANS_STATUS_NAME> 
    <TRANS_VALUE>-1.22</TRANS_VALUE> 
    <CURR_CODE_ALPHA>USD</CURR_CODE_ALPHA> 
    <TRANS_VALUE_SETTLED>-1.22</TRANS_VALUE_SETTLED> 
    <CURR_CODE_ALPHA_SETTLED>USD</CURR_CODE_ALPHA_SETTLED> 
    <TRANS_EXCH_RATE/>
    <TRANS_ID>69462</TRANS_ID> 
    <CUST_ID>1547</CUST_ID>
    <XTL_CUST_ID/>
    <PO_ID>261148</PO_ID>
    <XTL_ORDER_ID/>
    <BATCH_ID>1102</BATCH_ID>
    <PROC_NAME>Test Processor</PROC_NAME> 
    <MERCH_ACCT_ID>100</MERCH_ACCT_ID> 
    <CARD_BRAND_NAME>Visa</CARD_BRAND_NAME> 
    <CARD_TYPE>VISA BUSINESS</CARD_TYPE> 
    <CARD_PREPAID>0</CARD_PREPAID> 
    <CARD_BANK/>
    <CARD_BALANCE/> 
    <PMT_L4>1111</PMT_L4> 
    <PMT_ID/> <PMT_ID_XTL/>
    <PROC_UDF01/>
    <PROC_UDF02/> 
    <PROC_AUTH_RESPONSE>74282</PROC_AUTH_RESPONSE> 
    <PROC_RETRIEVAL_NUM>TESTRETRIEVE123</PROC_RETRIEVAL_NUM> 
    <PROC_REFERENCE_NUM/>
    <AVS_RESPONSE>M</AVS_RESPONSE> 
    <CVV_RESPONSE>M</CVV_RESPONSE> 
    <REQUEST_API_VERSION>4.4</REQUEST_API_VERSION> 
    <PO_LI_ID_1>300383</PO_LI_ID_1> 
    <PO_LI_COUNT_1>1</PO_LI_COUNT_1> 
    <PO_LI_AMOUNT_1>-1.22</PO_LI_AMOUNT_1> 
    <PO_LI_PROD_ID_1>1001</PO_LI_PROD_ID_1>
</RESPONSE>

5.4.2.2 Successful CCCREDIT Response Example​

<RESPONSE>
    <REQUEST_ACTION>CCCREDIT</REQUEST_ACTION>
    <TRANS_STATUS_NAME>APPROVED</TRANS_STATUS_NAME> 
    <TRANS_VALUE>-1.22</TRANS_VALUE> 
    <CURR_CODE_ALPHA>USD</CURR_CODE_ALPHA> 
    <TRANS_VALUE_SETTLED>-1.22</TRANS_VALUE_SETTLED> 
    <CURR_CODE_ALPHA_SETTLED>USD</CURR_CODE_ALPHA_SETTLED> 
    <TRANS_EXCH_RATE/>
    <TRANS_ID>21089</TRANS_ID> 
    <CUST_ID>1503</CUST_ID> 
    <XTL_CUST_ID/> 
    <PO_ID>215257</PO_ID>
    <XTL_ORDER_ID/>
    <BATCH_ID>1000</BATCH_ID>
    <PROC_NAME>Test Processor</PROC_NAME> 
    <MERCH_ACCT_ID>100</MERCH_ACCT_ID> 
    <CARD_BRAND_NAME>Visa</CARD_BRAND_NAME>
    <CARD_TYPE>VISA CLASSIC</CARD_TYPE> 
    <CARD_PREPAID>1</CARD_PREPAID>
    <CARD_BANK/>
    <CARD_BALANCE/>
    <PMT_L4>2244</PMT_L4>
    <PMT_ID/>
    <PMT_ID_XTL/>
    <PROC_UDF01/>
    <PROC_UDF02/> 
    <PROC_AUTH_RESPONSE>33086</PROC_AUTH_RESPONSE> 
    <PROC_RETRIEVAL_NUM>B515URX2-6GRACE123 ERROR</PROC_RETRIEVAL_NUM>
    <PROC_REFERENCE_NUM/>
    <AVS_RESPONSE>M</AVS_RESPONSE> 
    <CVV_RESPONSE>M</CVV_RESPONSE> 
    <REQUEST_API_VERSION>4.4</REQUEST_API_VERSION> 
    <PO_LI_ID_1>251038</PO_LI_ID_1> 
    <PO_LI_COUNT_1>1</PO_LI_COUNT_1> 
    <PO_LI_AMOUNT_1>-1.22</PO_LI_AMOUNT_1> 
    <PO_LI_PROD_ID_1>1001</PO_LI_PROD_ID_1>
    <MBSHP_ID_1/>
</RESPONSE>