API Reference

Clients

Typescript / Javascript library

yarn add @repaya/client

Example project on GitHub

Quick Start

import { Client } from '@repaya/client';
import express from 'express';

const apiToken = process.env.REPAYA_API_TOKEN;  /* repaya API token */
const formId = process.env.REPAYA_FORM_ID;      /* repaya payment form id */

/* create repaya client for the ethereum mainnet */
const repaya = new Client(process.env.REPAYA_DOMAIN, apiToken);  

const app = express();

app.use(express.static('public'));

/* Initiate the checkout fow and redirect user to complete the payment */
app.post('/checkout', async (req, res) => {
    const userId = 'user_42';           /* replace with the one in your system */
    const productId = 'product_65291';  /* replace with the one in your system */

    /* create a payment session */
    const session = await repaya.sessions.create(formId, {
    	customer: { id: userId },
     	product: {
            id: productId,
            name: 'Awesome product'
      	},
      	price: {
            USD_MULTI_1: '5.0',
     	}
    });
  
    res.redirect(303, session.checkoutUrl);
});

/* Handle the customer after the checkout and validate payment status */
app.get('/after_checkout', async (req, res) => {
    const sessionId = req.query.session;

    const payment = await repaya.payments.getBySession(sessionId);
	
    if (!payment || payment.status !== 'completed') {
        res.redirect(303, '/error');
        return;
    }

    res.redirect(303, '/success');
})

const port = process.env.PORT
app.listen(port, () => console.log(`Running server on port ${port}`));

Endpoints

Address	Description
https://repaya.io/api/public/1	Ethereum Mainnet
https://goerli.repaya.io/api/public/1	Goerli Ethereum Testnet

Authorization

Authorization is done via Bearer HTTP Authentication.

Provide your API Token within the corresponding header to get access to all API methods:

Authorization: Bearer <API_TOKEN>

Method

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

JavaScriptCurlPython

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"
}

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

JavaScriptCurlPython

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"
  }
}

List payments

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

Authorization

repayaAuth

Query parameters

Response

200

List of payments filtered by the given parameters.

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

JavaScriptCurlPython

const response = await fetch('https://repaya.io/api/public/1/payment/list?formId=jAY7k&limit=100&page=3&sort=asc&fromTimestamp=1669839216188&tillTimestamp=1669839216188', {
    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"
    }
  }
]

Get customer balances

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

Authorization

repayaAuth

Query parameters

Response

200

List of customer balances

Body

application/json

customerIdnullable string

Customer ID for this balance record. The record represents a total balance if this field is an empty string

Example: "user_123141"

productIdnullable string

Product ID for this balance record. The record represents a total balance if this field is an empty string

Example: "product_123141"

balancestring

Balance value

Example: "123.08"

coinobject

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "customerId": "user_123141",
    "productId": "product_123141",
    "balance": "123.08",
    "coin": {
      "code": "USD_MULTI_1",
      "name": "USD Stablecoins"
    }
  }
]

OpenAPI Spec

12KB

api.yml