Catalisa.Building Blocks
Catálogo/Payments/API

API do Payments

26 endpoints em 8 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

40 endpoints

Configurações de provedor

/payments/api/v1/provider-configs7
  • POST/payments/api/v1/provider-configsCadastra um gateway (testa a conexão antes de salvar)PAYMENTS_ADMIN
  • GET/payments/api/v1/provider-configsLista configurações, paginadoPAYMENTS_READ
  • GET/payments/api/v1/provider-configs/:idBusca uma configuraçãoPAYMENTS_READ
  • PATCH/payments/api/v1/provider-configs/:idAtualiza (revalida conexão se trocar credencial)PAYMENTS_ADMIN
  • DELETE/payments/api/v1/provider-configs/:idExclusão lógica. Responde 204PAYMENTS_ADMIN
  • POST/payments/api/v1/provider-configs/:id/set-defaultMarca como padrão da organizaçãoPAYMENTS_ADMIN
  • POST/payments/api/v1/provider-configs/:id/testTesta a conexão com as credenciais salvasPAYMENTS_ADMIN

Payment intents

/payments/api/v1/intents6
  • POST/payments/api/v1/intentsCria a intenção de cobrança. Responde 201PAYMENTS_WRITE
  • GET/payments/api/v1/intentsLista intents, paginadoPAYMENTS_READ
  • GET/payments/api/v1/intents/:idBusca um intentPAYMENTS_READ
  • POST/payments/api/v1/intents/:id/chargeExecuta a cobrança no provedorPAYMENTS_WRITE
  • POST/payments/api/v1/intents/:id/captureCaptura um valor autorizadoPAYMENTS_WRITE
  • POST/payments/api/v1/intents/:id/cancelCancela o intent no provedor e localmentePAYMENTS_WRITE

Estornos

/payments/api/v1/refunds3
  • POST/payments/api/v1/refundsCria estorno total ou parcial. Responde 201PAYMENTS_REFUND
  • GET/payments/api/v1/refundsLista estornos, paginadoPAYMENTS_READ
  • GET/payments/api/v1/refunds/:idBusca um estornoPAYMENTS_READ

Clientes e cartão salvo

/payments/api/v1/customers13
  • POST/payments/api/v1/customersCria ou devolve o cliente no provedor por externalReference. 201 se criou, 200 se já existiaPAYMENTS_WRITE
  • GET/payments/api/v1/customersLista clientes, paginadoPAYMENTS_READ
  • GET/payments/api/v1/customers/:idBusca um clientePAYMENTS_READ
  • POST/payments/api/v1/customers/:id/setup-sessionsAbre a página hospedada para o cliente cadastrar o cartão. Responde 201 com urlPAYMENTS_WRITE
  • GET/payments/api/v1/customers/:id/setup-sessions/:sessionIdEstado da sessão, com o método gravado quando concluídaPAYMENTS_READ
  • POST/payments/api/v1/customers/:id/setup-sessions/:sessionId/syncConsulta o provedor e, se o cliente concluiu, grava o cartãoPAYMENTS_WRITE
  • GET/payments/api/v1/customers/:id/payment-methodsCartões salvos, o padrão primeiroPAYMENTS_READ
  • POST/payments/api/v1/customers/:id/payment-methods/syncReconcilia com o provedor (grava o que existe lá, apaga o que sumiu)PAYMENTS_WRITE
  • POST/payments/api/v1/customers/:id/payment-methods/:methodId/defaultDefine o cartão padrãoPAYMENTS_WRITE
  • DELETE/payments/api/v1/customers/:id/payment-methods/:methodIdDesanexa no provedor e remove. Responde 204PAYMENTS_WRITE
  • POST/payments/api/v1/customers/:id/chargesCobra o cartão salvo sem o cliente presente. idempotencyKey obrigatóriaPAYMENTS_WRITE
  • GET/payments/api/v1/customers/:id/charges/:chargeIdEstado da cobrançaPAYMENTS_READ
  • POST/payments/api/v1/customers/:id/charges/:chargeId/syncConsulta o provedor (link de recuperação pago, pagamento em processamento)PAYMENTS_WRITE

Webhooks

/payments/api/v1/webhooks2
  • POST/payments/api/v1/webhooks/:providerTypeRecebe evento do gateway**Sem JWT** — assinatura do provedor
  • GET/payments/api/v1/webhooks/healthSonda simples do receptorPública

Analytics

/payments/api/v1/analytics3
  • GET/payments/api/v1/analytics/metricsMétricas agregadas do períodoPAYMENTS_READ
  • GET/payments/api/v1/analytics/time-seriesSérie histórica a partir dos snapshotsPAYMENTS_READ
  • POST/payments/api/v1/analytics/computeCalcula e grava um snapshot. Responde 201PAYMENTS_ADMIN

Saúde

/payments/health1
  • GET/payments/healthNome e versão do serviço