Amimpa
Documentação pública da API

Integre rápido com PIX, webhook e consulta de pagamentos.

Acesse a base da API, gere cobranças, consulte status e configure notificações automáticas sem depender do painel. Nos exemplos, valores monetários são sempre enviados e retornados em centavos; `valor_formatado` é apenas visual.

URL Base da API
/api

Headers
{
  "Content-Type": "application/json",
  "X-API-Key": "pk_test_xxx"
}
Corpo da requisição
{
  "valor": 1000,
  "comentario": "Pagamento PIX",
  "nome_pagador": "Nome do pagador",
  "cpf_pagador": "00000000000",
  "expira_segundos": 900
}
Exemplo curl
curl -X POST https://api.amimpa.com/api/v1/payments \
  -H "X-API-Key: pk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "valor": 1000,
    "comentario": "Cobrança PIX",
    "expira_segundos": 900
  }'
Resposta
{
  "status": true,
  "data": {
    "pagamento_id": "paypub_xxx",
    "valor": 1000,
    "valor_formatado": "R$ 10,00",
    "descricao": "Cobrança PIX",
    "status_pagamento": "pendente",
    "metodo": "PIX",
    "expira_em_segundos": 900,
    "expira_em": "2026-05-20T13:01:12.000Z",
    "qr_code": "000201010212...",
    "qr_code_imagem": "https://...",
    "criado_em": "2026-05-20 12:46:13",
    "referencia": "PAY-7839"
  }
}

Headers
{
  "Content-Type": "application/json"
}
Resposta [pendente]
{
  "status": true,
  "response": {
    "status_pagamento": "pendente",
    "valor": 1000,
    "valor_formatado": "R$ 10,00",
    "confirmado_em": null,
    "criado_em": "2025-12-09 19:05:08"
  }
}
Resposta [confirmado]
{
  "status": true,
  "response": {
    "pagador_nome": "Maria da Silva",
    "pagador_doc": "123.456.789-09",
    "status_pagamento": "pago",
    "valor": 1000,
    "valor_formatado": "R$ 10,00",
    "confirmado_em": "2025-12-09 19:10:32",
    "criado_em": "2025-12-09 19:05:08"
  }
}
Resposta [expirado]
{
  "status": true,
  "response": {
    "status_pagamento": "expirado",
    "valor": 1000,
    "valor_formatado": "R$ 10,00",
    "confirmado_em": null,
    "criado_em": "2025-12-09 19:05:08"
  }
}
Como confirmar pagamento
Existem duas formas. Escolha a que combina com seu fluxo.
Consulta manual por requisição

Use quando quiser confirmar sob demanda no seu backend ou em uma tela administrativa.

Confirmação automática por webhook

Use quando quiser automatizar baixa de pedido, liberação de produto ou atualização de status.

Webhook
Configure uma URL no painel para receber confirmação automática de pagamento.

Após configurar, enviaremos um POST para sua rota sempre que houver alteração no status do pagamento.

webhook.confirmed
{
  "event": "payment.confirmed",
  "pagamento_id": "paypub_xxx",
  "valor": 1000,
  "valor_formatado": "R$ 10,00",
  "status_pagamento": "pago",
  "pago_em": "2026-03-31 12:12:23"
}
Chave de API
A chave pessoal fica disponível dentro da sua conta, nos ambientes Sandbox e Produção.