Consultar formas de pagamento ativas

Retorna as formas de pagamento ativas no sistema configuradas com a opção Disponível para recebimento externo (habilitadas para totens físicos, TEF, WhatsApp e portais de autoatendimento).

No fluxo de pagamento externo, este endpoint permite que a aplicação descubra previamente quais meios de pagamento estão autorizados pela clínica para recebimento fora do balcão da recepção. Diferente do fluxo interno do sistema — onde a recepção visualiza todas as formas cadastradas da clínica (incluindo formas do tipo Pagar e formas restritas ao atendimento presencial) —, apenas modalidades com faturamento do tipo Receber ou Ambos liberadas para canais externos são retornadas.

A conta bancária de destino do recurso e as regras financeiras são previamente configuradas em cada forma de pagamento no Clínica nas Nuvens, garantindo a liquidação contábil automática quando a baixa for solicitada.

Listar formas de pagamento

curl -G "https://api.clinicanasnuvens.com.br/v1/checkout/formas-pagamento" \
  -H "Authorization: Basic BASE64_DO_CLIENT_ID_E_SECRET" \
  -H "clinicaNasNuvens-cid: SEU_TOKEN_DE_CLINICA"

Regras de negócio

• Apenas formas ativas, liberadas e de recebimento: Apenas formas de pagamento ativas com a opção Disponível para recebimento externo habilitada e cujo tipo de faturamento não seja Pagar (ou seja, apenas tipos Receber ou Ambos) são retornadas. Formas configuradas exclusivamente como Pagar são desconsideradas.
• Regras de Parcelamento:
  • Para formas de pagamento que permitem parcelamento (como Cartão de Crédito), o campo maximoParcelas informa o limite máximo de parcelas cadastrado pela clínica.
  • Para formas que não permitem parcelamento (como Pix, Cartão de Débito, Dinheiro), o campo maximoParcelas retorna sempre 1.
• Utilização no Fluxo de Checkout:
  • O campo id retornado nesta consulta deve ser repassado no parâmetro idFormaPagamento das rotas de baixa (/v1/checkout/agendas/{idAgenda}/baixar e /v1/checkout/faturas/{idFatura}/baixar).
  • O valor do campo tipoDocumento define se os campos de cartão (adquirente, estabelecimento, nsu, aprovadoEm) serão de preenchimento obrigatório nas rotas de baixa.

Exemplo de resposta

{
  "formas_pagamento": [
    {
      "id": 224309,
      "nome": "Cartão de Crédito - Totem",
      "tipoDocumento": "CARTAO_CREDITO",
      "maximoParcelas": 6
    },
    {
      "id": 224310,
      "nome": "Pix - Totem",
      "tipoDocumento": "PIX",
      "maximoParcelas": 1
    },
    {
      "id": 224311,
      "nome": "Cartão de Débito - Totem",
      "tipoDocumento": "CARTAO_DEBITO",
      "maximoParcelas": 1
    }
  ]
}

Campos da resposta

Campo	Tipo	Descrição
formas_pagamento	Array	Lista de formas de pagamento liberadas para autoatendimento.
id	Integer	Identificador único da forma de pagamento no sistema.
nome	String	Nome descritivo da forma de pagamento.
tipoDocumento	String	Tipo de documento financeiro associado (CARTAO_CREDITO, CARTAO_DEBITO, PIX, etc.).
maximoParcelas	Integer	Quantidade máxima de parcelas permitida.

Veja na Referência

Os detalhes de cada operação, campo a campo, estão em Referência › Checkout.