Bem-vindo(a) à documentação da API da Hipay! Este guia ajudará você a integrar sua aplicação à nossa plataforma de forma simples e eficiente. Nossa API é flexível, permitindo que você não apenas recrie elementos da nossa dashboard, mas também explore novas formas de utilizá-la.
A API segue os princípios RESTful e todas as respostas são retornadas no formato JSON. Abaixo, apresentamos os principais endpoints para começar:
| Ambiente | URL |
|---|---|
| Produção | https://api.hipay.com.br |
| Sandbox | https://api-sandbox.hipay.com.br |
Autenticação
Para autenticar-se à nossa API, você deve acessar a tela de integração em nossa dashboard, no ambiente em que deseja acessar e criar uma chave de autenticação e cadastrar seus webhooks.
Esta chave deve ser passada nos Headers com o nome X-API-KEY
Formato de valores
Todos os valores da API são representados em centavos. Ou seja o equivalente a
R$25,20em centavos, seria2520.