Integrating with the API

Starting the Apply and Checkout flows with the omni-link API

Custom integrations are possible using ChargeAfter's Omni-Link API. The Omni-Link API calls are used to send a link for the consumer to start an application or checkout. The link can be sent via email or SMS to either the consumer or merchant device. For tips on how to use the Omni-Link API calls, see here .

Sample flows are as follows:

Apply Flow on the Consumer's Device

Apply Flow on the Merchant's Device

Checkout Flow on the Consumer's Device

Checkout Flow on the Merchant's Device

Tracking Applications Created via Links

To determine if a consumer has created an application via the link, you can use various methods:

  • the GET .../v2/omni-link/consumer/{linkId} endpoint.
  • webhooks:
    • application.created: This event notification will be sent if an application was started from either an application or checkout link.
    • application.apply-confirmed: For an application link, this event notification will be sent if the consumer has confirmed their Apply request at the end of the application process.
    • application.checkout-confirmed: For a checkout link, this event notification will be sent if the consumer has confirmed their Checkout request at the end of the application process.

For more details on these methods, see their corresponding documentation.

Receiving Updated Cart Info

If the consumer updates a cart during checkout, you can receive updated cart info via the links.checkout-data-update webhook.