VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Formas de pagamento

Consultar formas de pagamento

Lista as formas de pagamento, consulta uma pelo id e mostra quais tipos cada gateway suporta.

Use a lista para montar uma tela de gestão ou sincronizar com outro sistema. A rota de gateways ajuda a montar o formulário de criação: ela mostra quais tipos de pagamento cada gateway realmente processa.

Listar as formas

Devolve todas as formas, ativas e inativas, de todos os donos, sem paginação.

GET/api/v1/admin/payment-methodsAdmin

Lista as formas de pagamento

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/payment-methods" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Formas
json
{
  "methods": [
    {
      "id": "08fd91cd-ce15-4b28-9482-db37b8778b36",
      "display_id": 26,
      "name": "Boleto Faturado",
      "code": "boleto-faturado",
      "processor_type": "invoiced",
      "gateway": "invoiced",
      "status": "A",
      "uses_credit_limit": false,
      "payment_period_days": 0,
      "uses_supplier_credit_limit": false,
      "config": {
        "installment_plans": [
          {
            "id": "30-60-90",
            "name": "30/60/90",
            "enabled": true,
            "terms_days": [
              30,
              60,
              90
            ],
            "installments": 3
          }
        ]
      },
      "position": 0,
      "created_at": "2026-07-08T02:58:06Z",
      "min_order_amount": 5000,
      "max_order_amount": 0,
      "surcharge_fixed": 0,
      "surcharge_percent": 0
    }
  ],
  "total": 1
}

Campos da resposta

methodsarray
Formas, com os campos abaixo.
totalinteger
Quantidade.
iduuid
Id da forma.
display_idinteger
Número curto para o painel (ex.: forma nº 26).
namestring
Nome mostrado ao cliente.
codestring
O slug informado na criação.
processor_typestring
onlineofflineinvoiced
online, offline ou invoiced.
gatewaystring
Gateway que processa.
providerstring
Tipo do pagamento (pix, boleto, credit_card...). Aparece só em algumas leituras.
statusstring
AD
A ativa ou D desativada.
configobject
Configuração livre do método; no boleto faturado traz installment_plans.
positioninteger
Ordem de exibição.
vendor_iduuid
Dono (seller). Ausente = vale para a loja toda.
vendor_namestring
Nome do seller dono.
min_order_amountinteger
Pedido mínimo em centavos.
max_order_amountinteger
Pedido máximo em centavos. 0 ou ausente = sem teto.
allowed_user_groupsarray
Ids de grupos de clientes permitidos.
blocked_user_groupsarray
Grupos bloqueados.
allowed_shipping_methodsarray
Ids de formas de envio permitidas.
allowed_statesarray
UFs permitidas.
surcharge_fixedinteger
Sobretaxa fixa em centavos aplicada ao total.
surcharge_percentinteger
Sobretaxa em pontos-base (250 = 2,50%).
uses_credit_limitboolean
Consome o limite de crédito do cliente (B2B).
uses_supplier_credit_limitboolean
Consome o limite do fornecedor.
payment_period_daysinteger
Prazo de pagamento em dias.
internal_code_1string
Código interno 1 para ERP.
internal_code_2string
Código interno 2 para ERP.
payment_codestring
Código do método usado pelas regras por cliente e pelo ERP.
created_atstring
Criação (RFC 3339).

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não tem manage_payments nem view_payments.{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}
Campos extras repetidos

Cada forma também traz payment_id, payment, template, processor, payment_category e timestamp, apelidos que repetem outros valores. Ignore-os em integrações novas.

Ver gateways e tipos

GET/api/v1/admin/payment-methods/gatewaysAdmin

Gateways e tipos suportados

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/payment-methods/gateways" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Mapa gateway para tipos
json
{
  "gateways": {
    "braspag": [
      "credit_card",
      "debit_card",
      "boleto"
    ],
    "pagarme": [
      "credit_card",
      "debit_card",
      "pix",
      "boleto"
    ],
    "pix": [
      "pix"
    ],
    "venddor_pay": [
      "credit_card",
      "pix",
      "boleto"
    ]
  }
}

Campos da resposta

gatewaysobject
Chave = gateway; valor = lista dos tipos (credit_card, debit_card, pix, boleto) que ele processa. A lista completa depende da loja.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não tem manage_payments nem view_payments.{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}

Consultar uma forma

GET/api/v1/admin/payment-methods/{id}Admin

Consulta uma forma de pagamento

Parâmetros de caminho

iduuidobrigatório
Id da forma.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/payment-methods/08fd91cd-ce15-4b28-9482-db37b8778b36" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Forma
json
{
  "id": "08fd91cd-ce15-4b28-9482-db37b8778b36",
  "display_id": 26,
  "name": "Boleto Faturado",
  "code": "boleto-faturado",
  "processor_type": "invoiced",
  "gateway": "invoiced",
  "status": "A",
  "uses_credit_limit": false,
  "payment_period_days": 0,
  "uses_supplier_credit_limit": false,
  "config": {
    "installment_plans": [
      {
        "id": "30-60-90",
        "name": "30/60/90",
        "enabled": true,
        "terms_days": [
          30,
          60,
          90
        ],
        "installments": 3
      }
    ]
  },
  "position": 0,
  "created_at": "2026-07-08T02:58:06Z",
  "min_order_amount": 5000,
  "max_order_amount": 0,
  "surcharge_fixed": 0,
  "surcharge_percent": 0
}

Campos da resposta

iduuid
Id da forma.
display_idinteger
Número curto para o painel (ex.: forma nº 26).
namestring
Nome mostrado ao cliente.
codestring
O slug informado na criação.
processor_typestring
onlineofflineinvoiced
online, offline ou invoiced.
gatewaystring
Gateway que processa.
providerstring
Tipo do pagamento (pix, boleto, credit_card...). Aparece só em algumas leituras.
statusstring
AD
A ativa ou D desativada.
configobject
Configuração livre do método; no boleto faturado traz installment_plans.
positioninteger
Ordem de exibição.
vendor_iduuid
Dono (seller). Ausente = vale para a loja toda.
vendor_namestring
Nome do seller dono.
min_order_amountinteger
Pedido mínimo em centavos.
max_order_amountinteger
Pedido máximo em centavos. 0 ou ausente = sem teto.
allowed_user_groupsarray
Ids de grupos de clientes permitidos.
blocked_user_groupsarray
Grupos bloqueados.
allowed_shipping_methodsarray
Ids de formas de envio permitidas.
allowed_statesarray
UFs permitidas.
surcharge_fixedinteger
Sobretaxa fixa em centavos aplicada ao total.
surcharge_percentinteger
Sobretaxa em pontos-base (250 = 2,50%).
uses_credit_limitboolean
Consome o limite de crédito do cliente (B2B).
uses_supplier_credit_limitboolean
Consome o limite do fornecedor.
payment_period_daysinteger
Prazo de pagamento em dias.
internal_code_1string
Código interno 1 para ERP.
internal_code_2string
Código interno 2 para ERP.
payment_codestring
Código do método usado pelas regras por cliente e pelo ERP.
created_atstring
Criação (RFC 3339).

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não tem manage_payments nem view_payments.{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}
404Forma inexistente.{"error":"payment method not found"}

Veja também

  • Formas de pagamento
Anterior
Formas de pagamento
Próxima
Criar, alterar e apagar formas
Nesta página
  • Listar as formas
  • Exemplo de requisição
  • Resposta
  • Erros
  • Ver gateways e tipos
  • Exemplo de requisição
  • Resposta
  • Erros
  • Consultar uma forma
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também