Implementation Overview

Below are high level steps to implementing Loop.

Getting set up

1. Create your account

The first step is to create an entity. Here you will be able to set the payoutDestination, defining where payments should be sent, as well as the paymentTypes, defining the tokens and networks that an end User can pay Merchants. If the payout destination is a bank account, you will need to contact Loop to complete KYB.

Relevant API: Create entity
Relevant Guide: Create your entity

2. Configure merchants (optional)

By default, your entity is a Merchant, and can receive payments to it's payoutDestinations. If you a platform supporting other Merchants, you may want to configure these Merchants in Loop so they can have their own unique payout destination and accepted tokens , networks and their payments are kept seperate.

Relevant API: Create merchant
Relevant Guide: Creating merchants

3. Configure webhooks

If you are using Loop for subscriptions or are not using our Pay component, you will need to configure webhooks to hear about payment confirmations and failures.

The only field thats required in the create webhook request is the postUrl which is where the webhook will be sent to (it does allow for more detailed control but thats the easiest setup). Once that's configured, the URL that you configured will get an event each time a payin is created and when the payin is processed on chain.

Relevant API: Create webhooks
Relevant Guide: Webhooks

4. Set up your payment gateway

Before you can charge a customer, you must create a customer with a paymentMethod in Loop and then get the wallet's approval.

The easiest way to enable this is by embedding Loop's Pay component in your checkout process. When the Pay component is used, it will create a customer and paymentMethod, initiate the requesit transaction to get the wallet's approval, and initiate your first payin. Our components are configurable, embeddable web components designed to simplify your integration to Loop while retaining your platform's look, feel and control of your Merchant and User's experience.

If you would like to not use Loop's component, you can create the customer, paymentMethod and gather the approval yourself. Here are directions and sample code to get the wallet's approval.

Relevant API: Create customer
Revenant Docs: LoopConnect Library

Taking payments

5. Take the first payment

Using Loop's Pay Component

When initiating the Pay component, you will tell the component which Merchant is being paid and for how much. Using the MerchantId, the component will show only the pre-configured networks and tokens. The User will be able to connect their wallet and click Pay. This will initiate:

1. Creating the customer in Loop
2. Assigning that customer a paymentMethod based on the network and token they select and marking that method as default
3. Initiate the first payment using the parameters passed in
4. Check the paymentMethod’s status to confirm the payment will be successful
5. Respond with any steps to rectify errors (e.g. low balance or low authorization)
6. Initiate the Create payin if authorization and balance checks have passed
7. Respond with any success or error codes as well as the customerId that is used to send additional payins for this customer

Use APIs to take the first payment

If you are not using the component, then you will need to repeat each of the steps above by calling our API endpoints.

1. If not already done, you will need to create the customer with a paymentMethod by calling the Create customer endpoint
   1. The paymentMethod’s status will be included in the response
2. Send a payin request if authorization and balance checks have passed using the Create Payin endpoint
3. Listen to webhooks for response

6. Send Loop subsequent payments

While the Pay component allows Merchants to get paid for the 1st payment, all subsequent payments must be sent using the Create Payin endpoint.

That's it!