Refunds

Send a refund request to credit a
SETTLED
 capture. A refund request requires the request ID and reconciliation ID returned in the capture response.

Endpoints

Set the
apRefundService_run
 field to
true
, and send the request to one of these endpoints:
Production:
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
Test:
https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor

Response Status

The refund service responds with one of these statuses as the
apRefundReply_status
 field value:
  • FAILED
    : The refund request failed.
  • PENDING
    : The refund request is accepted but is not refunded. Request the check status service to retrieve status updates.
  • REFUNDED
    : The captured payment is successfully refunded.
The refund service also responds with a reason code as the
apRefundReply_reasonCode
 field value.

Example: Refunding a Payment with XML

Light Dark
Request
123456789101112
<="urn:schemas-cybersource-com:transaction-data-1.213"> 
   <merchantID>test_merchant</merchantID>
   <merchantReferenceCode>refnum-1234</merchantReferenceCode>
   <purchaseTotals>
      <currency>USD</currency>
      <grandTotalAmount>1</grandTotalAmount>
   </purchaseTotals>
   <apPaymentType>afp</apPaymentType>
   <apRefundService run="true">
      <refundRequestID>6246277717236180203285</refundRequestID>
   </apRefundService> 
</>
Response to a Successful Request
1234567891011121314151617181920
<:c="urn:schemas-cybersource-com:transaction-data-1.213"> 
   <merchantReferenceCode>refnum-1234</merchantReferenceCode>
   <requestID>6246279076626811503016</requestID>
   <decision>ACCEPT</decision>
   <reasonCode>100</reasonCode>
   <purchaseTotals>
      <currency>USD</currency>
      </purchaseTotals>
   <apRefundReply>
      <reasonCode>100</reasonCode>
      <transactionID>47797f6a-d894-428b-91d2-8408e8a53c5a</transactionID>
      <status>REFUNDED</status>
      <processorResponse>00006</processorResponse>
      <amount>1.00</amount>
      <reconciliationID>XFZOSQ97H6UE</reconciliationID>
      <returnRef>EE3FLQ9GXCWH</returnRef>
      <paymentStatus>refunded</paymentStatus>
      <responseCode>00006</responseCode>
   </apRefundReply>
</>