KyvoPay

Consultar pagamento

Busca uma cobrança pelo id e lista o histórico.

GET/v1/payments/{id}Chave de API

Consultar por id#

GET/v1/payments/{id}Chave de API

Devolve a cobrança completa, mais dois campos que só aparecem aqui: timeline, com cada mudança de estado, e webhook_deliveries, com as entregas relacionadas. Ótimo para investigar “por que meu sistema não recebeu o evento”.

Não use em polling

Consultar em laço consome seu limite de requisições e atrasa a sua própria integração. Cadastre um webhook e consulte apenas quando precisar reconciliar.
GET/v1/payments/{id}
curl https://api.kyvopay.com.br/v1/payments/pay_3Kq8Zx91 \
  -H "X-API-Key: $KYVO_API_KEY"
200 OKresposta
{
  "data": {
    "id": "pay_3Kq8Zx91",
    "status": "paid",
    "amount_centavos": 12990,
    "net_centavos": 12945,
    "paid_at": "2026-08-11T19:03:11Z",
    "customer": {
      "name": "Ana Ribeiro",
      "email": "ana@exemplo.com"
    },
    "timeline": [
      { "event_type": "created", "created_at": "..." },
      { "event_type": "paid", "created_at": "..." }
    ],
    "webhook_deliveries": [
      { "event_type": "payment.paid", "status": "delivered", "attempts": 1 }
    ]
  },
  "error": null,
  "request_id": "req_88b1e0f3"
}

Listar cobranças#

GET/v1/paymentsChave de API

A resposta traz items, page, per_page e total. Vários filtros aceitam lista separada por vírgula.

Parâmetros de consulta

pageintegeropcional

Página, começando em 1.

per_pageintegeropcional

De 1 a 100. Padrão 25.

statusstringopcional

Um ou mais status: paid,pending.

methodstringopcional

pix, card, boleto — aceita lista.

qstringopcional

Busca por id público, descrição ou end-to-end id.

min_amount / max_amountintegeropcional

Faixa de valor em centavos.

date_from / date_todatetimeopcional

Intervalo de criação, em ISO 8601.

customer_iduuidopcional

Filtra por cliente.

has_refundbooleanopcional

Apenas cobranças com ou sem reembolso.

orderstringopcional

recent, oldest, amount_desc ou amount_asc.

Cancelar#

POST/v1/payments/{id}/cancelChave de API

Só cobranças em pending ou processing podem ser canceladas. Depois de paga, o caminho é o reembolso. Alguns processadores não suportam cancelamento — nesse caso a resposta é 422 e a cobrança expira naturalmente.

GET/v1/payments
curl -G https://api.kyvopay.com.br/v1/payments \
  -H "X-API-Key: $KYVO_API_KEY" \
  -d status=paid \
  -d method=pix \
  -d page=1 \
  -d per_page=25 \
  -d order=recent