Skip to main content
curl --request GET \
  --url https://api.pagou.ai/v1/health-check \
  --header 'Accept: application/json' \
  --header 'apiKey: {SUA_API_KEY}'

{
    "status": "RUNNING",
    "datetime": "2025-07-15T21:58:10.886Z",
    "application": "payment-service",
    "version": "2.0.3"
}
Para utilizar as APIs de integração da Pagou.ai, é necessário possuir uma API Key, que pode ser obtida por meio de um de nossos representantes ou através do nosso portal.

​
Como Usar a API Key nas Requisições HTTP

Antes de realizar qualquer requisição às APIs de integração, inclua a API Key no cabeçalho da requisição usando o parâmetro apiKey.
1

Obtenha sua API Key

Solicite sua API Key com um representante Pagou.ai ou acesse o portal Pagou.ai.
2

Inclua a API Key no cabeçalho da requisição

Adicione o cabeçalho apiKey em todas as requisições HTTP para autenticação.
3

Realize a requisição HTTP

Envie a requisição para o endpoint desejado, incluindo o cabeçalho de autenticação.
​
apiKey
string
required
Chave de autenticação fornecida pela Pagou.ai. Inclua este valor no cabeçalho de todas as requisições.

​
Exemplos de Uso

curl --request GET \
  --url https://api.pagou.ai/v1/health-check \
  --header 'Accept: application/json' \
  --header 'apiKey: {SUA_API_KEY}'

Exemplo de configuração do cabeçalho no Postman

curl --request GET \
  --url https://api.pagou.ai/v1/health-check \
  --header 'Accept: application/json' \
  --header 'apiKey: {SUA_API_KEY}'

{
    "status": "RUNNING",
    "datetime": "2025-07-15T21:58:10.886Z",
    "application": "payment-service",
    "version": "2.0.3"
}
Se a API Key não for informada ou for inválida, a requisição retornará um erro 403 com a mensagem “Forbidden Resource”.
{
  "statusCode": 403,
  "error": "Forbidden"
  "message": "Forbidden Resource"
}
⌘I