Introduction

Welcome to the kamiPay documentation! Here you'll find everything you need to integrate kamiPay into your applications.

What is kamiPay?

kamiPay offers a flexible framework to integrate Pix Payment into your existing services. With kamiPay's integration with Pix, you can offer your users the possibility to:

• Receive payments from bank accounts in Brazil
• Pay to bank accounts in Brazil internationally
• Receive payments in local currency or stablecoin

What are kamiPay APIs?

kamiPay API features powerful endpoints that simplify complex Fiat to Crypto operations into a simple set of APIs.

In our API set you will find:

• Oracles: Get real-time exchange rate information
• Pix Generation: Generate a Pix Payment request
• Status: Get information about payment status
• WebHooks: Receive push notifications about status changes
• Pix Payment: Understand how to pay to a Brazilian account
• Pix key Lookup: Verify the owner of a Pix key before making a payment

We also feature additional endpoints where local FIAT offramp is available.

Supported Blockchains

We support Polygon Blockchain for API connectivity. Specific Tron Support can be provided on a demand basis.

Authentication

In order to use our APIs, you will need to be provided with an API-User/Secret.

If you have already obtained the API-User/Secret, check Authentication to get the access token and start using our APIs.

Base URL

The kamiPay API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. The API does not support HTTP.

When you first connect, you'll get Development Credentials where the base URL is:

https://devnakamotoapi2.kamipay.io

Once your project is ready to go to production, we'll provide you access to:

https://api2.kamipay.io

Response Codes

kamiPay uses standard HTTP codes to indicate the success or failure of your requests.

In general:

• 2xx HTTP codes correspond to success
• 4xx codes are for user-related failures
• 5xx codes are for infrastructure issues