Paying for an order · Commerce Cloud

When you checkout a cart, you are returned an unpaid order. You can handle payment through a number of payment gateways.

note

You need to configure and enable a payment gateway before you can accept payments for orders.

warning

You can use the Manual Gateway to handle payments from non-supported payment providers, such as PayPal.

caution

There are a number of actions that happen to your inventory when checking out and paying for an order. For more information, see Inventory.

Payment methods

Depending on the chosen gateway, you may or may not have access to capture funds immediately or authorize for later payment.

Transactions

Purchase

The simplest method is purchase. The gateway attempts to charge the customer immediately, and the result of the attempt is returned.

Authorize

You can authorize a payment so funds can later be captured when an item is dispatched or restocked.

Capture

After you have an authorized transaction, you want to capture the authorized funds.

Refunds

You can use either the Refund through Commerce Cloud or use the Mark as Refunded capability, or a combination of both capabilities.

Refund through Commerce Cloud

You can start a full or partial refund to a supported payment provider directly from the Elastic Path Commerce Cloud dashboard or the API. When you start the refund process, the refund request is sent to the payment gateway. You no longer have to log on to your payment gateway’s console to process the refund.

When you process a refund, use the refund endpoint to pass the refund amount. If you don’t pass an amount, the refund is processed as Mark as refunded. For more information, see the Mark as Refunded section.

Each time a partial refund is triggered, the transaction.updated event is generated and updated with refunded.amount. The order.updated event is also triggered. The order.refunded event generates when the full amount is refunded.

Mark as Refunded

You can use your payment gateway’s console to process a refund. Process the refund first in the payment gateway and then use the Mark as Refunded capability in Commerce Cloud to complete the process.

When an order is Marked as refunded, the payment status order.payment.status is set to refunded. In this case, the order.updated, transaction.updated and order.refunded events are generated.