Applying store credit
Learn how to apply store credit.
Providing and highlighting a loyalty reward builds customer loyalty and increases profitability. This topic explains how to leverage the power of the store credit program to reward and retain loyal shoppers by leveraging the Commerce API.
To support store credit, Commerce API requires more than one source in a cart. You need to create a source for the shopper's payment and another source for the store credit. Once you create both sources, you can attach them to the cart for the charge.
Store credit flow
Create a store credit source.
Attach the secondary source to the cart (for example, the store credit source).
Attach the primary source to the cart (for example, the credit card source). Note: If the secondary source can cover the entire order amount, you can skip this step.
If you configured notifications, the shopper receives an order confirmation notification. See Post-order notifications for more information.
Cancel an order that used store credit
You can use Global Commerce to cancel an order or line item if it has not been shipped or fulfilled.
If you configured notifications, the shopper receives a cancellation notification. See Line item cancel completed for more information.
Refund an order with store credit
You cannot cancel an order or line item if it has been shipped or fulfilled. You must return or refund the order or line item using Global Commerce, the Refunds API, or the configureReturns API.
The shopper requests a refund. If you configured notifications, the shopper receives a user refund confirmation.
Digital River processes the refund request. See Store credit notification for more information.
Post-order notifications
Post-order notification (PON) polls events and collects data using real-time calls for your company or site. When an event occurs, it triggers a notification and sends it to your endpoint. The notifications are one way. Once you receive a notification, you are free to do whatever you want with that notification. To turn on and configure PON, see the Post-order notification integrationguide.
A PON tells you when a shopper uses store credit and how much store credit the shopper uses when an event occurs. A PON is triggered when an order is submitted, refunded, or cancelled. The PON generates an XML containing the order data. The store credit amount and payment method amount will appear in the notification's Order object under extendedAttributes. You can extract the content of an order event to see the amount the shopper paid by store credit and other payment methods.
The following table shows that a PON is sent when: (1) a shopper submits an order, (2) a shopper requests a refund for an order or line item, and (3) a shopper cancels an order or line item.
| Flow sequence | Event description | Post-order notification |
|---|---|---|
1 | Shopper submits the order. | Notify the the client system to subtract the store credit. |
2 | Shopper requests a refund for the order or a line item. Digital River processes the refund for the customer. | Notify the client system to return the store credit. |
3 | Shopper cancels the order or a line item. | Notify the client system to return the store credit. |
Order submitted notification
The order submitted notification displays the payment method and store credit under extendedAttributes. If you want to receive a notification when an order event occurs, contact your Digital River representative.
Line item cancel completed notification
The line item cancel completed notification shows the cancelled store credit under extendedAttributes. If you want to receive a notification when the store credit was not consumed so you can reflect it on your system, contact your Digital River representative.
Return credit complete notification
The return notification shows the refunded store credit under extendedAttributes. If you want a post-order notification sent to your system to notify you that the store credit was not consumed so you can reflect it on your system, contact your Digital River representative.
Last updated
