Introduction
Understand general concepts and response codes.
What is kamiPay?
kamiPay offers a flexible framework to integrate Pix Payment into your existing services. With kamiPay integration with Pix you can offer your users the possibility to Receive a Payment from a bank account in Brazil or to Pay to a BankAccount in Brazil internationally while having the possibility to receive your payment in local currency or stablecoin.
What are kamiPay APIs?
kamiPay API features powerful endpoints that simplify a complex Fiat to Crypto operation into a simple set of APIS.
In our API set you will find:
- Oracles: to get real time exchange rate information.
- Pix Generation: to generate a Pix Payment request.
- Status: To get information about payment status.
- WebHooks: To get push notifications about status changes.
- Pix Payment: To understand how to Pay to a Brazilian account.
We will feature also a set of additional endpoints where local FIAT offramp is available
Supported blockchains
We support Polygon Blockchain for API connectivity. Specific Tron Support can be provided on demand basis.
Authentication
In order to use our APIs you will need to be provided by an API-User/Secret.
Please Contact Us for more information.
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, and 5xx
codes are for infrastructure issues.
Status | Description |
---|---|
200 | Successful request. |
201 | Created. |
400 | Check that the parameters were correct. |
401 | Check that authentication credentials were correct. |
5xx | Indicates an error with kamiPay servers. |
🛈 Check Error Codes for a comprehensive breakdown of all possible API errors.