Skip to main content
GET
Esta rota responde a uma pergunta direta: quais formas de pagamento esta conta pode oferecer? Para cada uma, ela informa os países onde funciona e as moedas aceitas. Use essa lista para montar as opções do seu checkout. A Finvia oferece cartão de crédito (inclusive cartão salvo e Apple Pay) e Pix. Ela também é a chamada mais simples para validar uma chave de API: uma resposta 200 confirma que a autenticação está correta.

Quando usar

Para o negócio: as formas de pagamento disponíveis dependem da configuração da sua conta na Finvia. Se um meio que você espera não aparece na lista, fale com o seu contato comercial antes de pedir ao time técnico para integrar.

Antes de chamar

Parâmetros de consulta

Nenhum parâmetro é obrigatório.
string
Filtra os meios de pagamento pelo ID do merchant. Ex.: 2vorkDcXyvzifL63YX09S9VqcnI.
string
Filtra os meios de pagamento pela moeda (código ISO 4217). Ex.: BRL.

Respostas

A resposta 200 é um array de meios de pagamento, sem paginação.
string
Identificador único do meio de pagamento. Ex.: 2vorkDcXyvzifL63YX09S9VqcnI.
string
Nome técnico do meio de pagamento. Ex.: pix.
string[]
Países onde o meio está disponível (ISO 3166-1 alpha-3). Ex.: ["BRA"].
string[]
Moedas aceitas pelo meio (ISO 4217). Ex.: ["BRL"].
string
Nome para exibir na tela. Ex.: Pix.
Para o desenvolvedor: use description como rótulo no checkout e name como chave no seu código. O contrato não garante que name seja igual ao type usado em POST /v1/charges. Confira os valores devolvidos na sua conta antes de mapear um para o outro. O exemplo desta página é ilustrativo.

Exemplos por caso de uso

A primeira chamada depois de gerar a chave.
Resposta 200 com um array (mesmo vazio) confirma que a chave e o cabeçalho estão corretos.

Erros comuns

Veja também

Credenciais e ambientes

Gere a chave e faça a primeira chamada.

Formas de pagamento

Quando usar cada forma de pagamento.

Saldos e meios de pagamento

Guia de saldo, saque e meios de pagamento.

Consultar saldos

Saldo por moeda.