> For the complete documentation index, see [llms.txt](https://p00ls.gitbook.io/token-os/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://p00ls.gitbook.io/token-os/payments-api/introduction.md).

# Introduction

### **Points-to-Crypto On/Off-Ramp**

Many companies already have internal point systems (such as loyalty programs or in-app/game currencies), through which their customers are able to easily earn and redeem those points.  For those companies looking to extend their points programs into web3, we wanted to create an easy way to convert those points balances into $TOKENs.

Our Payments and Delivery API is the very first points-to-crypto on/off-ramp, designed to facilitate the acceptance of payments in your own $TOKEN, as well as the delivery of $TOKENs to your end users. &#x20;

You will be able to:

* Accept payments in $TOKEN
* Convert points into $TOKENs
* Convert $TOKENs into points

### Gas-Free Transactions for Your Users

Every transaction through this API is designed to be gas-free for your end-user.  This means that you will be paying the gas fees for each transaction.

To do so, you will need to deposit funds to a relayer to pay for the fees.  Over time, you'll need to continuously top up your relayer balance on an as-needed basis.

### Configuration

Some configuration is required upfront before being able to use this API.

**Webhook addresses**

You'll need to provide us with 3 webhook URLs for the following:

1. **Payments Webhook URL** to be pinged upon success of a payment transaction.
2. **Deliveries Webhook URL** to be pinged upon success of a delivery transaction.
3. **Relayer Webhook URL** to be pinged when your relayer balance is low.

#### Relayer setup&#x20;

TokenOS will setup an [OpenZeppelin Defender Relayer](https://www.openzeppelin.com/defender) wallet for you on your behalf, that will be used to pay gas fees for your end-users.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://p00ls.gitbook.io/token-os/payments-api/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
