Skip to main content

Bem-vindo à Promisse - Gateway de Pagamento

Esta é a documentação oficial da API da Promisse, uma solução completa para processar pagamentos online de forma segura, rápida e eficiente.

Autenticação

Todos os endpoints requerem autenticação via Bearer Token no header Authorization. Exemplo:
Authorization: Bearer SEU_TOKEN_AQUI

Endpoints Principais

Consultar Pagamentos

GET /payments Retorna todos os pagamentos cadastrados. Parâmetros opcionais:
  • limit (integer): Limite de resultados.
Resposta de sucesso:
[
  {
    "id": 123,
    "valor": 100.00,
    "status": "aprovado"
  }
]

Criar Pagamento

POST /payments Cria um novo pagamento. Body:
{
  "valor": 100.00,
  "descricao": "Pedido #123"
}
Resposta de sucesso:
{
  "id": 124,
  "status": "pendente"
}

Deletar Pagamento

DELETE /payments/{id} Remove um pagamento pelo ID. Resposta de sucesso: Status 204 (No Content)

Webhook de Pagamento

POST /payments/webhook Recebe notificações de eventos de pagamento. Body:
{
  "id": 124,
  "status": "aprovado"
}
Resposta de sucesso: Status 200