Skip to main content

5.5 Refund

5.5.1 Minimum required parameters to issue a refund (CCCREDIT):​

Merchants can request the return of an authorization by sending the CCCREDIT value in the request_action parameter.

5.5.1

Important Note

Merchants should only refund transactions that have been captured or settled.

A different amount from the original authorization can be sent in the LI_VALUE_1 parameter. However, the amount cannot exceed the total of the original authorization. The exception is a forced refund.

5.5.2 Forced Refund Request​

A forced refund is a type of transaction where the refund request is sent directly to the daily cutoff file. Merchants do not need to send the REQUEST_REF_PO_ID parameter in this type of request. However, the FORCE_CREDIT parameter is required along with the complete credit card data.

Important Note

Forced refunds are only available for certain merchants. Please contact your payment processing service representative for more information.

5.5.3 OCT (Original Credit Transaction)​

A forced refund can also be sent as an original credit transaction. This feature allows the merchant to refund an amount greater than the one originally received. The REQUEST_REF_PO_ID parameter is used for this type of refund, as it is used to retrieve the payment information from the original transaction.

5.5.3

5.5.4 Multiple Line Items​

Note: If your merchant account does not plan to handle purchase orders with items spanning more than one line, please skip this section. For more information, contact your payment processing Service Support representative.

The payment service supports purchase orders with information across more than one line item. This feature will be useful for customers with businesses using "shopping cart" models.

Merchants can use this feature by sending the LI_PROD_ID_X, LI_COUNT_X, and LI_VALUE_X parameters. "X" indicates that this value is dynamic and must be replaced by a number depending on how many line items the merchant wants to send.

5.5.5 CCAUTHORIZE Request Example with Multiple Line Items.​

5.5.5

The request for the items to be processed should look like this:

/pmt_service.cfm?req_username=test@example.com&req_password=TestPassword1&request_action=CCAUTHORIZE&request_api_version=4.4&site_id=0&merch_acct_id=100&cust_fname=John&cust_lname=Doe&cust_email=test@example.com&cust_login=username1&cust_password=12345678Xx&bill_addr=1%20Main%20Street&bill_addr_city=Hollywood&bill_addr_state=CA&bill_addr_zip=90078&bill_addr_country=US&pmt_numb=5105105105105100&pmt_key=123&pmt_expiry=12/2025&request_response_format=XML&xtl_ip=10.00.000.99&LI_PROD_ID_Xli_prod_id_1=1001&li_value_1=19.95&li_count_1=1&li_prod_id_2=2001&li_value_2=10.50&li_count_2=1

Note

Replace "CCAUTHORIZE" with "CCAUTHCAP" in the request above to make a CCAUTHCAP request instead of CCAUTHORIZE.

5.5.6 CCAUTHORIZE Response Example with Multiple Line Items​

Below, the line item response parameters are highlighted in bold.

<RESPONSE>
    <REQUEST_ACTION>CCAUTHORIZE</REQUEST_ACTION> 
    <TRANS_STATUS_NAME>APPROVED</TRANS_STATUS_NAME> 
    <CURR_CODE_ALPHA>USD</CURR_CODE_ALPHA>
    <TRANS_VALUE>30.45</TRANS_VALUE> 
    <CURR_CODE_ALPHA>USD</CURR_CODE_ALPHA> 
    <TRANS_VALUE_SETTLED>30.45</TRANS_VALUE_SETTLED> 
    <CURR_CODE_ALPHA_SETTLED>USD</CURR_CODE_ALPHA_SETTLED> 
    <TRANS_EXCH_RATE/>
    <TRANS_ID>30000</TRANS_ID> 
    <CUST_ID>2000</CUST_ID>
    <XTL_CUST_ID/>
    <PO_ID>77777</PO_ID>
    <XTL_ORDER_ID/>
    <BATCH_ID>1001</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>51402</PROC_AUTH_RESPONSE> 
    <PROC_RETRIEVAL_NUM>7169CEF3-64EF-46BB- 55A333956994D2D</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>123455</PO_LI_ID_1> 
    <PO_LI_COUNT_1>1</PO_LI_COUNT_1> 
    <PO_LI_AMOUNT_1>19.95</PO_LI_AMOUNT_1> 
    <PO_LI_PROD_ID_1>1001</PO_LI_PROD_ID_1> 
    <PO_LI_ID_2>123456</PO_LI_ID_2> 
    <PO_LI_COUNT_2>1</PO_LI_COUNT_2> 
    <PO_LI_AMOUNT_2>10.5</PO_LI_AMOUNT_2> 
    <PO_LI_PROD_ID_2>2001</PO_LI_PROD_ID_2>
    <MBSHP_ID_1/> 
</RESPONSE>

5.5.7 Specific Line Item Capture Request Example​

5.5.7

Merchants should only use request_ref_po_li_id when sending a deferred capture request against a specific line item.

5.5.8 Capturing, Reversing or Refunding the Full Order with Multiple Line Items​

To capture, reverse or refund the entire purchase order, simply send the correct REQUEST_ACTION and REQUEST_REF_PO_ID with the other required parameters in the API request.

5.5.8.1 Multiple Items: CCCAPTURE Request Example​

Note that this request will capture the second line item from the CCAUTHORIZE example above:

 /pmt_service.cfm?req_password=TestPassword1&site_id=0&request_ref_po_li_id=123456&request_ref_po_id=77777&chkavs=F&request_response_format=JSON&req_username=test%40example.com&li_value_1=10.50&request_action=CCCAPTURE&request_api_version=4.4

5.5.8.2 Multiple Lines: Approved CCCAPTURE Response Example​

<RESPONSE> 
    <REQUEST_ACTION>CCCAPTURE</REQUEST_ACTION>
    <TRANS_STATUS_NAME>APPROVED</TRANS_STATUS_NAME> 
    <TRANS_VALUE>10.5</TRANS_VALUE> 
    <CURR_CODE_ALPHA>USD</CURR_CODE_ALPHA> 
    <TRANS_VALUE_SETTLED>10.5</TRANS_VALUE_SETTLED> 
    <CURR_CODE_ALPHA_SETTLED>USD</CURR_CODE_ALPHA_SETTLED>
    <TRANS_EXCH_RATE/>
    <TRANS_ID>124447</TRANS_ID> 
    <CUST_ID>2000</CUST_ID>
    <XTL_CUST_ID/>
    <PO_ID>77777</PO_ID>
    <XTL_ORDER_ID/>
    <BATCH_ID>1101</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/> 
    <PROC_RETRIEVAL_NUM>9287005b-0740-4049-8526-9dcc6f06e610</PROC_RETRIEVAL_NUM> 
    <PROC_REFERENCE_NUM>5478723</PROC_REFERENCE_NUM>
    <AVS_RESPONSE/>
    <CVV_RESPONSE/> 
    <REQUEST_API_VERSION>4.4</REQUEST_API_VERSION> 
    <PO_LI_ID_1>123456</PO_LI_ID_1> 
    <PO_LI_COUNT_1>1</PO_LI_COUNT_1> 
    <PO_LI_AMOUNT_1>10.5</PO_LI_AMOUNT_1> 
    <PO_LI_PROD_ID_1>2001</PO_LI_PROD_ID_1> 
    <MBSHP_ID/>
</RESPONSE>

5.5.9 Request Example to Reverse a Specific Line Item​

5.5.9

5.5.9.1 Multiple Items: CCREVERSE Request Example​

/pmt_service.cfm?req_password=TestPassword1&site_id=0&request_ref_po_li_id=123456&request_ref_po_id=77777&chkavs=F&request_response_format=XML&req_username=test%40example.com&li_value_1=10.50&request_api_version=4.4&request_action=CCREVERSE

5.5.9.2 Multiple Items: CCREVERSE Response Example​

<RESPONSE> 
    <REQUEST_ACTION>CCREVERSE</REQUEST_ACTION>
    <TRANS_STATUS_NAME>APPROVED</TRANS_STATUS_NAME> 
    <TRANS_VALUE>-10.50</TRANS_VALUE> 
    <CURR_CODE_ALPHA>USD</CURR_CODE_ALPHA> 
    <TRANS_VALUE_SETTLED>-10.50</TRANS_VALUE_SETTLED> 
    <CURR_CODE_ALPHA_SETTLED>USD</CURR_CODE_ALPHA_SETTLED> 
    <TRANS_EXCH_RATE/>
    <TRANS_ID>100002</TRANS_ID> 
    <CUST_ID>2000</CUST_ID>
    <XTL_CUST_ID/>
    <PO_ID>77777</PO_ID>
    <XTL_ORDER_ID/>
    <BATCH_ID>1001</BATCH_ID>
    <PROC_NAME>Test Processor</PROC_NAME> 
    <MERCH_ACCT_ID>100</MERCH_ACCT_ID> 
    <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>5100</PMT_L4>
    <PMT_ID/>
    <PMT_ID_XTL/>
    <PROC_UDF01/><PROC_UDF02/> 
    <PROC_AUTH_RESPONSE>69803</PROC_AUTH_RESPONSE> 
    <PROC_RETRIEVAL_NUM>31B22CB-A453-GRA3CE5</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>123456</PO_LI_ID_1> 
    <PO_LI_COUNT_1>1</PO_LI_COUNT_1> 
    <PO_LI_AMOUNT_1>-10.50</PO_LI_AMOUNT_1> 
    <PO_LI_PROD_ID_1>2001</PO_LI_PROD_ID_1> 
    <MBSHP_ID/>
</RESPONSE>

5.5.9.3 Refunding a Single Line Item Only​

5.5.9.3

5.5.9.4 Multiple Items: CCCREDIT Request Example​

/pmt_service.cfm?req_password=TestPassword1&site_id=0&request_ref_po_li_id=123456&request_ref_po_id=77777&chkavs=F&request_response_format=XML&req_username=test%40example.com&li_value_1=10.50&request_api_version=4.4&request_action=CCCREDIT

5.5.9.5 Multiple Items: CCCREDIT Response Example​

<RESPONSE> 
    <REQUEST_ACTION>CCCREDIT</REQUEST_ACTION>
    <TRANS_STATUS_NAME>APPROVED</TRANS_STATUS_NAME> 
    <TRANS_VALUE>-10.5</TRANS_VALUE> 
    <TRANS_ID>100002</TRANS_ID> 
    <CURR_CODE_ALPHA>USD</CURR_CODE_ALPHA> 
    <TRANS_VALUE_SETTLED>-10.5</TRANS_VALUE_SETTLED> 
    <CURR_CODE_ALPHA_SETTLED>USD</CURR_CODE_ALPHA_SETTLED> 
    <TRANS_EXCH_RATE/>
    <CUST_ID>2000</CUST_ID> 
    <XTL_CUST_ID/>
    <PO_ID>77777</PO_ID>
    <XTL_ORDER_ID/>
    <BATCH_ID>1001</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>BANK OF TEST BANKS</CARD_BANK> 
    <CARD_BALANCE/>
    <PMT_L4>5100</PMT_L4>
    <PMT_ID/>
    <PMT_ID_XTL/>
    <PROC_UDF01/><PROC_UDF02/> 
    <PROC_AUTH_RESPONSE>69803</PROC_AUTH_RESPONSE> 
    <PROC_RETRIEVAL_NUM>31B22CB-A453-GRA3CE5</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>123457</PO_LI_ID_1> 
    <PO_LI_COUNT_1>1</PO_LI_COUNT_1> 
    <PO_LI_AMOUNT_1>-10.5</PO_LI_AMOUNT_1> 
    <PO_LI_PROD_ID_1>2001</PO_LI_PROD_ID_1> 
    <MBSHP_ID/>
</RESPONSE>

5.5.10 Line Item Types​

The line item type is not returned in the Payment Processing Service API response, however this data will be available in some customer reports. The table below lists the different line item types.

Line Item Type IDDescription
1Goods and services
2Discount
3Tax
4Shipping
5Chargeback
6Refund