Use with your checkout

Introduction

1. Create a product
2. Create an offer
3. Create the order
4. Get the orders’ payment info
5. Charge the order
6. Create webhooks (optional)

This flow does not support any credit card payment, if you want to charge with credit card use Lia’s checkout.

Creating a product

To create a product you will first need to select a correct Kind and Shift:

1. List all kinds and select the one that fits the most
2. List all shifts and select the one that fits the most
3. Create the product

Creating an offer

To create an offer you will need the product ID and build the payment configurations:

1. Get the product ID from the previous step
2. Build the payment configurations for that offer
3. Create the offer

Create the order

To create the order you will need first to get the customer’s correct city and state.

1. List cities and get the correct city ID
2. Send the city and state id in the request

Getting order’s payment info

You will only need the offer id from previous step, use this to show to your client all payment options available so they can choose

Charge the order

1. Get the payment configuration selected by your customer from the previous step and send in the charge request
2. Return the payment to your customer, it will be the first payment in the first bill in the first billing.

Create webhooks

Create webhooks to receive all updates from our entities.

1. Define if you will need a webhhook by Order, Billing or Bill.
2. Define the events you will need to listen.
3. Create the webhook with the entity that fits the most your use case.