On This Page

Sale

Send a sale request to begin processing a payment. A response to a successful request includes a pending status and a URL in the
apSaleReply_merchantURL
 field. Redirect the customer to the URL to allow the customer to complete the payment on their bank's website.
After sending a successful request, you can send a follow-on check status request or a refund request. These follow-on services require the request ID from the sale response, which is the
requestID
 field value.
Pay by Bank requires that you include line items in your sale request. Line items are used to include information about the goods and services that your customers purchase, such as product name, quantity, and price.

Endpoints

Set the
apSaleService_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

Cybersource
 responds to your sale request with one of these statuses in the
apSaleReply_status
 field:
  • PENDING
    : The sale request is accepted but the customer has not completed checkout. A webhook notification informs you when the customer completes checking out and the sale settles. See Webhook Subscriptions. If you do not receive a webhook notification, send a check status request. See Check Status.
  • REJECT
    : The sale is not successful. Send a new sale request.
Cybersource
 also responds with a reason code in the
apSaleReply_reasonCode
 field. For more information about reason codes, see Reason Codes and Pay by Bank Response Codes.
If you send a check status request to retrieve the current sale status, these are the possible responses:
  • ABANDONED
    : The customer did not complete checkout before the redirect URL expired.
  • COMPLETED
    : The customer completed the checkout process and the sale is currently under review. You can send the check status request in 60-minute intervals to retrieve the current status.
  • PENDING
    : The sale request is accepted but is not complete. You can send the check status request in 60-minute intervals until the status updates.
  • REJECT
    : The sale request is not successful. An unsuccessful request can be due to either Pay by Bank rejecting the transaction or a technical error.
  • SETTLED
    : The sale is complete for the requested amount.