Referência do Core/Cash In
POST

Criar cobrança Pix

Cria uma nova cobrança Pix (cash in).

POST/v1/payments
https://integrate.api.kyvopay.com.br
cURL
curl -X POST "https://api.kyvopay.com.br/v1/payments" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN" \
  -H "X-Business-Id: UUID_DA_EMPRESA" \
  -H "Content-Type: application/json" \
  -d '{}'

Autenticação

X-API-Keystring · headerobrigatório

Use a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.

Operação do Core implementada por DashboardController.createPayment().

Endpoint

POST/v1/payments

Autenticação

Sessão do lojista. Requer JWT válido e empresa ativa/selecionada; o Core aplica MerchantBusinessGuard.

Guards encontrados no controller: JwtAuthGuard, MerchantBusinessGuard.

Requisição

Implementação no Core

Arquivo: modules/dashboard/dashboard.controller.ts
Handler: DashboardController.createPayment()

Nota

Esta página foi sincronizada do Core atual. Campos específicos de corpo e resposta devem permanecer alinhados ao controller e aos DTOs do Core.

Precisa de ajuda? Fale com o suporte
© 2026 KyvoPay