Online Store

Online store integration enables you to sell multiple products at their corresponding prices using a single payment form. You can also track how much each customer paid for products or the total amount paid for all products in your store.

Payment Form

Set up an Integration form and fill in the necessary details:

• Your store address (for example, mystore.com)

• Coins that you accept for payment

• Your receiving blockchain address

• Your return URL. This is the address on your website to redirect customers after they complete the payment. More information on it is below.

Backend Integration

To build the checkout flow on your site, you will need to make two things happen from your server:

1. Create a payment session and redirect users by the URL you get from repaya API

2. Handle returning users after they complete the payment

1. Create a payment session

Perform a request to repaya's Rest API to create a payment session. Be sure to set IDs in the customer and product fields to the corresponding IDs in your own database to be able to verify them after the payment is complete. Use the checkoutUrl field from the response to redirect your user.

Create payment session

Create a payment session to initiate the checkout flow

POSThttps://repaya.io/api/public/1/session

Authorization

repayaAuth

Body

application/json

formLinkId*string

Example: "jAY7k"

customerobject

productobject

priceobject

clientIdstring

Example: "key_1432"

Response

200

Payment session created

Body

application/json

checkoutUrl*string

Redirect customer to this url to complete the payment

Example: "https://repaya.io/checkout/id_124124"

id*string

Payment session ID

Example: "id_124124"

formLinkId*string

Example: "jAY7k"

receiver*string

Example: "0x0000000000000000000000000000000000000000"

customerobject

productobject

priceobject

clientIdstring

Example: "key_1432"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://repaya.io/api/public/1/session', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "formLinkId": "jAY7k"
    }),
});
const data = await response.json();

Response

200

{
  "checkoutUrl": "https://repaya.io/checkout/id_124124",
  "id": "id_124124",
  "formLinkId": "jAY7k",
  "receiver": "0x0000000000000000000000000000000000000000",
  "customer": {
    "id": "user_123141"
  },
  "product": {
    "id": "product_123141",
    "name": "Awesome product"
  },
  "price": {
    "USD_MULTI_1": "15.0"
  },
  "clientId": "key_1432"
}

To let your customers select the quantity of the product, just include it in the form on your site and then fill in the session request as follows:

{
  // ...
  product: {
    name: "Awesome product x5",
    id: "product_12345"
    data: "{ \"quantity\": \"5\" }"
  }
  // ...
}

When a customer completes the payment, you will get back this payment data for further verification on your side.

2. Verify payment

When the payment is completed, the customer will be redirected to your website on the return URL you provided during the payment form setup. Verify the payment status at this step by requesting it via the API. The sessionId for the request will be provided to you in the query parameter of the return URL.

Save the resulting payment in your DB if you want to enumerate all the customer payments later or use them another way.

Get customer's payment in the given session

GEThttps://repaya.io/api/public/1/payment

Authorization

repayaAuth

Query parameters

Response

200

A payment associated with a given session, null if missing

Body

application/json

idstring

Example: "pid_3251"

customerobject

productobject

senderstring

Example: "0x0000000000000000000000000000000000000000"

receiverstring

Example: "0x0000000000000000000000000000000000000000"

amountstring

Example: "15.0"

paidAmountstring

Example: "5.0"

statusenum

Example: "pending"

completedpendingfailedcanceled

coinobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://repaya.io/api/public/1/payment?sessionId=id_124124', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "id": "pid_3251",
  "customer": {
    "id": "user_123141",
    "data": "text"
  },
  "product": {
    "id": "product_123141",
    "name": "Awesome product",
    "data": "text"
  },
  "sender": "0x0000000000000000000000000000000000000000",
  "receiver": "0x0000000000000000000000000000000000000000",
  "amount": "15.0",
  "paidAmount": "5.0",
  "status": "pending",
  "coin": {
    "code": "USD_MULTI_1",
    "name": "USD Stablecoins"
  }
}

Keep your payment session ID a secret. During the checkout flow, it should only be revealed to the customer who is performing the payment at the moment. It is also used to register and identify the payment.

See also

Check out the full Rest API Reference and Client libraries section to find out more.

You can also find the complete working example for this flow on Github.