Order API integration steps
For SeQura's integration in the online-shop checkout, the shop needs to make four of calls to SeQura's API. Calls 1, 3 and 4 are almost identical, and call 2 is a simple GET without mandatory parameters.
1. Start solicitation
When the shop wants to offer seQura payment to a customer, it starts by doing an API call passing the cart and all the customer data (see Order API Payload and Examplesfor exact specification).
The result of this call is a URL which will be used in the following steps. Read more
2. Present the identification form:
The next step lets the shopper to accept and validate the service conditions and identification details. Also, when the shop requests the form it identifies the kind of financial product to use (invoicing, part payment or seasonal campaign).
The identification form may contain different fields depending on a number of factors: known data from step 1, missing data or content of the cart, and the financial information. Typical fields are birth date and mobile number.
Depending on the type of integration or where the shopper is interacting from, the shop may want to render the form in the website, or to send a SMS to the shopper's mobile phone with a link to the identification form.
Important, the identification form must be filled and completed by the shopper, never by a store operator or other third person.
2.1 Working in an online ecommerce
When the environment is an online ecommerce, the better solutions is to render the form in the website. Use the URL to fetch an HTML snippet which has to be included as-is in the checkout page. This HTML snippet will use javascript to present an identification form to the user and to send the user's answers back to SeQura. Read more
2.2 The sale channel isn't online
When the purchase process doesn't run online with the shopper interacting with a website, like a sale from a call center, from the TPV of a physical store, or a delayed purchase... the shop can request seQura to send a SMS to the shopper's phone to let her to continue with the identification.
To do this, the store uses the Forms Deliveries API to send a SMS directly to the shopper's mobile phone. This SMS contains an URL that will open the phone's web browser and render a HTML form. This HTML form will use javascript to present an identification form to the user and to send the user's answers back to SeQura. Read more
3. Confirm order:
The user fills in the fields and sends the data to SeQura's API using AJAX. Depending on the user's answers, further fields might be added to the form dynamically, e.g. to ask the user to enter a PIN code that was sent to their mobile, or to make the down payment for a part payment.
Once seQura accepts the credit risk for this purchase, the user is redirected to a return url in the shop, which you must create as part of the integration. (The URL of the custom action should be included in the data sent in step 1.)
Once seQura has approved the order, it sends an IPN request and the shop must confirm that the order is actually being placed. The main purpose of this action is to make sure that the customer has not changed the content of the order cart during the checkout process. In case there have been any changes in the cart, the process must start again. Read more
3.1 When the shop cannot receive IPN
Some integrations may not allow to receive an inbound request (IPN) from SeQura, for instance in stand alone TPV software in a physical store. Since the POS software is working from an isolated environment, the process has to be started manually by any store operator. Read more
4. Register order reference
You can do this during the step 3, or if the reference will be generated later in a different system, like an ERP software, it must be informed in a separated step.
If seQura still thinks the purchase is OK and if nothing has changed in the shop to stop the order (e.g. if the checkout lasted two days and you have run out of certain products), it is time for you to convert the cart to a confirmed order. Once you have done that, you should send your order reference to SeQura. From this point, you will not need the URL that was obtained in step 1. Read more
Quick introduction guide
You can download this document to have a quick view of the checkout process: Quick introduction guide
Common scenarios
Implement only the steps you need for you use case.
Online ecommerce
- Step 1. Start solicitation Read more
- Step 2. Fetch the identification form Read more
- Step 3. Confirm the order from IPN Read more
- Step 4. If it requires a different reference from a third ERP system, register the order reference Read more
Call center
- Step 1. Start solicitation Read more
- Step 2. Send the identification form by SMS Read more
- Step 3. Confirm the order from IPN Read more
- Step 4. If it requires a different reference from a third ERP system, register the order reference Read more
Client/Server TPV for a physical store
The TPV software is a client and the server is accessible from SeQura.
- Step 1. Start solicitation Read more
- Step 2. Send the identification form by SMS Read more
- Step 3. Confirm the order from IPN Read more
- Step 4. If it requires a different reference from a third ERP system, register the order reference Read more
Isolated TPV software for a physical store
In this scenario the TPV software is autonomous.
Updated 5 days ago