Payments

This API can be used to initiate and manage payment requests for your own $TOKEN, allowing you to seamlessly accept payments from users.

ERC20 Permit

This feature relies on the ERC20 Permit extension. ERC20 Permit is an extension to the ERC20 token standard that allows users to pre-approve a token transfer that anyone can execute on their behalf.

If you are using your own ERC20 contract, you MUST implement ERC20 Permit in order to use the TokenOS Payments API.

In order for the end user to sign the permit with their wallet, you will need to implement the following flow within your application:

• Create a payment request

• Use our returned parameters to ask your user to sign a permit

• Post back the permit

• Poll the payment request for its status, or be notified by web hook

Create a new payment request

POSThttp://localhost:8080/v1/payments

Body

application/json

CreatePaymentRequestDto (object)

Response

200

Created

Body

application/json

CreatePaymentRequestResponseDto (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/v1/payments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{}

Get a payment request information and status

GEThttp://localhost:8080/v1/payments/{requestId}

Path parameters

requestId*string

Response

200

Payment request information

Body

application/json

PaymentRequestDto (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/v1/payments/{requestId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{}

Conversion Rate

If you have an existing points program, you'll likely establish a fixed or variable conversion rate from your own points to your own $TOKEN.

Payment requests can also save a conversion rate. This feature allows you to atomically create a payment request and retain a conversion rate that you have computed on your end.

This can be especially useful if you need to lock in a specific exchange rate for a particular transaction.