Checkout accept

The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.

The Checkout accept module allows you to assign a pending status for loyalty points. When enabled, the checkout event is extended by an additional verification step that ends in accepting/rejecting the transaction. This pending state is recorded within Antavo for the customer – any awarded points will be stored as pending points. The pending checkout can be accepted or rejected either by sending Checkout accept or Checkout reject API events, or automatically based on configured Checkout accept module settings.

When handling pending transactions, please make sure you use either the Pending events module or the Checkout accept module. We recommend to keep using the module and the configuration that has been implemented, or contact the Antavo Service Desk in case you need changes.

Configuring Checkout accept settings

Find the configuration page under the Modules menu by searching for the Checkout accept item in the module list.

If your brand uses Points economy, the Checkout accept module configuration is integrated into Points economy module, therefore you need to open the Points economy module and navigate to the Pending points tab of the Points economy module to configure the Checkout accept settings.

If your brand uses Multi-accounts, the Checkout accept module configuration is integrated into Points economy module, therefore you need to open the Multiaccounts module. You can configure the Checkout accept module settings for each account by clicking the ‘Edit’ button and navigating to the Pending points tab.

The page will open to the setup page with the following interfaces depending on the module you use:

Checkout accept module setup

Pending points settings under the Points ecomony module

Type

Manual
The transaction remains pending until a checkout_accept or a checkout_reject event is registered in the customer’s events history with the ID of the pending purchase. Until the checkout is not accepted or rejected with the mentioned event, you can use the checkout_update event to make modifications, except for the auto_accept date field value which can only be set by the checkout event.
Learn more about these events in our API docs here.
Auto Accept
The transaction is automatically accepted with a checkout_accept event in a predefined period of time relative to the time when the purchase is made.
All manually registered checkout_accept, checkout_reject, checkout_update are still applicable for the transaction during the pending period, but none of them are after this ends.
Auto Reject
The transaction is automatically rejected with a checkout_reject event in a predefined period of time relative to the time when the purchase is made.
All manually registered checkout_accept, checkout_reject, checkout_update are still applicable for the transaction during the pending period, but none of them are after this ends.

Interval

Define the duration of the pending period by adding the number of days (0 is not applicable).
The value of the auto_accept field will be calculated from the registration date of the checkout event:

auto_accept date value = date of the checkout event + interval

eg. If there’s a 30-day interval configured and the checkout is registered on 15th Dec, the auto_accept day of the checkout will be 14th Jan.

Recalculate auto-accept date

This checkbox provides the option to automatically extend the date value of the Auto accept field when a checkout_update event is registered.
The new value is calculated based on the following method:

updated auto_accept date value= date of the checkout_update event + interval

eg. If there’s a 30-day interval configured and a pending checkout is updated on 5th Jan, the newly calculated auto-accept day will be 4th Feb.

If this option is not enabled, the auto_accept field can only be updated by sending a new auto_accept field value in a checkout_update event or by modifying the event through a workflow.

Extend pending points

If you use the Multiaccounts module, the ‘Extend pending points’ box allows enforcing the settings configured in the account-independent Checkout accept module. As a result, the account-specific ‘Type’ and ‘Interval’ (if any) configurations will lapse and be overridden by the settings of the Checkout accept module.
Please contact the Antavo Service Desk if you need help with the setup.

Don’t forget to save your settings by clicking the ‘Save’ button.

Guest checkout handling

In case you send guest checkout information to Antavo, a previously registered anonym guest checkout can be claimed by a loyalty member through the registration of a checkout_claim API event.
The points are allocated based on the status of the checkout when the checkout_claim event is sent.

If the checkout is still in a pending status based on the Checkout accept module settings, the points are added as pending points to the customer’s account and will be confirmed when the checkout_accept event is registered.
If the checkout has already been accepted, the points are added to the customer’s account as spendable points right away.

The expiration date of the guest checkout points (if any) is calculated based on the date of the checkout_accept event.