Getting Started

Before we start, let us first discuss some terms and concepts you need to know before building your payment flows.

Payment Form

The concept of a Payment Form is at the core of the system. It is the main building block for all checkout flows.

Payment forms come in two types:

  • Payment Request is a simpler invoice-like form with a pre-defined set of coins and payment amounts. Its main use is for invoicing, donation forms, or deposit flows.

  • Integration is a more complex payment form that is mainly useful for selling multiple products with different prices under a single payment form. An online store or a subscription-based service is the perfect use for this type of form.

Continue to the Guides section to learn more about different form types and their applications.

Coin

When building a payment form, you need to select crypto coins available for payment.

On repaya, a coin can be an ERC20 token, the Ethereum itself, or multiple coins combined in a single basket. Your customers select a single coin to pay with from the list you have provided.

Check out the Supported Coins page to learn more about coins and coin baskets.

Balance

Balance is a record of the total amount of funds customers transferred to you using a given payment form. At the basic level, it tracks just the total in each coin but using a more complex API integration, you can track the total balances for each customer and the product they have purchased. This can be used, for example, to set up a deposit flow for your service.

Payment

Payment is an intent of a customer to transfer funds on the specified payment form. Payments are initiated by the customers using a Payment Session created from a store's side.

Payments can be of two types:

  • Unidentified - anonymous payments from an address not linked with any known customer or product. This type of payment is primarily used for invoices and donations.

  • Identified - payments linked to a specific customer and product with corresponding IDs provided via the API.

Learn more about repaya's system entities and how to interact with them in the API Reference.

Last updated