All requests must include both an api token and a business id.

This flow provisions an order in the etika platform, captures the required customer information to allow etika to make a decision on there application and finally commences the customers loan and settles the payment with the merchant.

1. Merchant calls the Get Products endpoint to retrieve etika order limits, possibly as part of an asynchronous scheduled background process.
2. Merchant stores these minimum and maximum order values server-side.
3. Separately, at the checkout, Merchant uses the stored etika minimum and maximum order values to determine if etika should be presented as an available payment method.
4. Merchant calls the Create order endpoint to retrieve an etika order token.
5. Merchant uses the token to direct the Consumer through the etika express checkout flow https://portal.au.etika.com/checkout/express/#/?oid={orderToken}.
6. Consumer completes the etika express checkout flow and is returned to the Merchant website.
   • If the Consumer clicks confirm, they will be returned to the redirectConfirmUrl provided in the Create order request.
   • If the Consumer clicks cancel, they will be returned to the redirectCancelUrl provided in the Create order request.
   • If the Consumer application is DECLINED and the click continue, they will be returned to the redirectDeclinedUrl provided in the Create orderrequest.
   • If the merchant is able to fulfil the order, the merchant calls the Create Payment endpoint to capture the payment.
7. Payment status (APPROVED or DECLINED) is only known once Create Payment has been completed.
   • If the payment was approved by etika, the Merchant presents the Consumer with an order confirmation/receipt page.
   • If the payment was declined by etika, the Merchant presents an appropriate message to the Consumer at the checkout

When creating/updating a resource using the API, all POST/PUT/PATCH actions can be initiated with a x-pb-request-id header with a unique string for that request.

Any request that returns a 2XX status code will only be created/updated once, and can be safely repeated for at least 20 minutes. A response that returns a 5XX but is expected to return a 2XX and was initiated with a x-pb-request-id header, can safely be repeated until a 2XX status code is recieved.

We recommend that a GUID or other high entropy value (such as a SHA-1 hash) is used to decrease the chances of a collision.