Check a Direct Debit Status

You can verify the status of a direct debit sale or refund. Checking direct debit status requires the request ID from the sale or refund response message.
When you check the status of a sale,
Cybersource
 recommends that you request the check status service at the end of each day. The end of day is defined by Greenwich Mean Time (GMT).

Shipping Policy

Cybersource
 recommends shipping the purchased goods after the direct debit status is settled.

Endpoints

Set the
apCheckStatusService_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 Statuses

The check status service responds with one of these statuses in the
apCheckStatusReply_status
 field:
Response Statuses for Checking Sale Status
  • Canceled
    : The customer cancelled the payment.
  • Chargeback
    : The customer asked for money back from their bank after the payment was settled.
  • Failed
    : Payment failed.
  • Pending
    : The direct debit request is accepted. The payment is scheduled to be sent to the inter-banking system to initiate a debit from the customer's account.
  • Returned
    : The customer completed a refund.
  • Reversed
    : The payment was cancelled after the sale was initiated and before the sale was settled.
  • Settle_accepted
    : The payment is accepted by the inter-banking system, and money is expected to arrive in your account within 5 days.
  • Settle_initiated
    : The payment is sent to the inter-banking system, but funds have not yet been received.
  • Settle_rejected
    : The payment was rejected by the inter-banking system.
  • Settled
    : The payment is complete, and the funds will be settled in your merchant account. You can begin shipping the purchased goods.
Response Statuses for Checking Refund Status
  • Pending
    : The refund request is accepted.
  • Refund_initiated
    : Refund request is being sent to the bank as a credit transfer.
  • Refund_rejected
    : The credit transfer request was rejected by the
    Bacs
     scheme.
  • Refunded
    : The credit transfer was successfully completed.
The check status service also responds with a reason code in the
apCheckStatusReply_reasonCode
 field. For more information about reason codes, see the Reason Codes for Bacs Direct Debits for the Simple Order API.

Required Fields for Checking Direct Debit Status

Set to either the sale or refund request ID.
Set to
true
.
Set to
bacs
.
mandateID

Test Triggers for Checking Statuses

In the
Cybersource
 test environment, you can simulate specific response messages that you receive from transaction requests by including certain values in your transaction requests. The simulated environment enables you to become familiar with the response messages and develop methods for error handling.
Your account must be configured for testing trigger values. Contact your
Cybersource
 account manager for more details.

Test Endpoint

For test transactions, send an API request to the test endpoint.
Test:
https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor

Trigger Values

To test, send a check status request, and set the
apCheckStatusService_reconciliationID
 field to a value listed in the Trigger Value column. The
Cybersource
 response status is returned in the
apCheckStatusReply_paymentStatus
 field.
Direct Debit Test Triggers for Checking Statuses
Cybersource
 Response Status
Trigger Value
Chargeback
TC200028
Failed
TC200010
Pending
TC200000
Refunded
TC200021
Refund-initiated
TC200029
Refund-rejected
TC200032
Settle-accepted
TC200026
Settled
Any value that is not used in the triggers for testing other statuses.
Settled-initiated
TC200027
Settle-rejected
TC200030

Simple Order Example: Checking Direct Debit Status

Light Dark
Request
12345678
<="urn:schemas-cybersource-com:transaction-data-1.214">
	<merchantID>test-merchant</merchantID>
	<merchantReferenceCode>refnum-4321</merchantReferenceCode>
	<apPaymentType>STL</apPaymentType>
	<apCheckStatusService run="true">
		<checkStatusRequestID>5235448386266004701064</checkStatusRequestID>
	</apCheckStatusService>
</>
Response to a Successful Request
12345678910111213
<:c="urn:schemas-cybersource-com:transaction-data-1.214">
    <merchantReferenceCode>refnum-1234</merchantReferenceCode>
    <requestID>7103581570376296104009</requestID>
    <decision>ACCEPT</decision>
    <reasonCode>100</reasonCode>
    <requestToken>AxjnrwSTgRX/ad56oQBJ//8ZYjWmdmpJk12DeOnvv7LpAedC/oH9MMmkmXoxX9xYJOAzGCyOZcODWAAA9Bva</requestToken>
    <apCheckStatusReply>
        <reasonCode>100</reasonCode>
        <reconciliationID>XFZ3YTIIW07G</reconciliationID>
        <paymentStatus>settle_initiated</paymentStatus>
        <processorResponse>00012</processorResponse>
    </apCheckStatusReply>
</>