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

Braspag

O gateway Braspag no painel: credenciais, captura, cancelamento, estorno, split entre sellers e cadastro de sub-lojistas.

A Braspag é um gateway de pagamento brasileiro (cartão de crédito e boleto). Em um marketplace ela também faz o split: o dinheiro de uma venda é dividido entre vários sellers (lojistas). Cada seller é cadastrado na Braspag como sub-lojista (subordinate merchant) e recebe um subordinate_merchant_id. Esta área do painel configura a integração e opera os pagamentos já criados pelo checkout.

Pontos principais
  • Tudo fica atrás do módulo braspag. Com ele desligado, qualquer rota responde 403 module_disabled.
  • Quem cria o pagamento é o checkout da loja (rota de cliente). Aqui você só captura, cancela, estorna e consulta.
  • O paymentId é o GUID do pagamento na Braspag, não o id do pedido da Venddor.
  • Valores são inteiros em centavos (4990 = R$ 49,90). Taxas (mdr, commission_percent) são em pontos-base (350 = 3,50%).
  • O acesso exige o privilégio manage_payments ou view_payments, e nenhuma rota separa leitura de escrita: veja os erros comuns.

Como funciona

  1. O administrador grava as credenciais (Configuração) e testa a conexão.
  2. Cada seller é cadastrado como sub-lojista (Sub-lojistas). A Braspag analisa o cadastro (KYC) e o status evolui até approved.
  3. O cliente paga no checkout. O cartão pode ser só autorizado.
  4. O administrador captura o valor (Ações de pagamento) e, em marketplace, usa a captura com split para repartir entre sellers.
  5. Se preciso, cancela (antes da captura) ou estorna (depois).

Status do sub-lojista

StatusSignificado
pendingEnviado, em análise na Braspag.
approvedAprovado; pode receber split.
rejectedReprovado na análise.
suspendedSuspenso manualmente; não pode receber split.

Conceitos

Sandbox e produção

environment é sandbox (padrão) ou production. Sem configuração gravada para a loja, a plataforma usa as credenciais padrão do servidor. Mantenha sandbox até validar o fluxo inteiro.

Segredos

merchant_key e client_secret são segredos. A leitura da configuração os devolve mascarados (**** mais os 4 últimos caracteres).

Endpoints

MétodoCaminhoPara quê
GET/api/v1/admin/braspag/configLê a configuração
PUT/api/v1/admin/braspag/configGrava a configuração
POST/api/v1/admin/braspag/test-connectionTesta as credenciais
PUT/api/v1/admin/braspag/payments/{paymentId}/captureCaptura
PUT/api/v1/admin/braspag/payments/{paymentId}/voidCancela
POST/api/v1/admin/braspag/payments/{paymentId}/refundEstorna
PUT/api/v1/admin/braspag/payments/{paymentId}/split-captureCaptura com split
GET/api/v1/admin/braspag/payments/{paymentId}/splitsConsulta o split gravado
GET/api/v1/admin/braspag/sellersLista sub-lojistas
POST/api/v1/admin/braspag/sellersCadastra sub-lojista
GET/api/v1/admin/braspag/sellers/{vendorId}Consulta um sub-lojista
PUT/api/v1/admin/braspag/sellers/{vendorId}Atualiza um sub-lojista
PATCH/api/v1/admin/braspag/sellers/{vendorId}/statusMuda o status

Erros comuns

  • Usar o id do pedido como paymentId. A Braspag não o conhece; use o GUID de pagamento devolvido na criação do pagamento.
  • Esperar mensagem de erro detalhada. Capturar, cancelar e estornar devolvem 500 com mensagem genérica; o motivo real só aparece no log do servidor.
  • Dividir com valores que não somam o pagamento. A API valida cada regra, mas não confere a soma contra o valor do pagamento; a Braspag é quem recusa.
  • Dividir para um seller não aprovado. A rota de captura com split não confere o status do seller: quem recusa é a Braspag. Só envie subordinate_merchant_id de sub-lojistas approved.
  • Achar que view_payments só lê. Nestas rotas ele também executa capturas, estornos e cadastros.
  • Guardar a resposta do PUT de configuração. Ela devolve a configuração com os segredos sem máscara (veja Configuração).

Próximos passos

Configuração
Credenciais e teste de conexão.
Sub-lojistas
Cadastre os sellers antes de dividir.
Captura com split
Reparta a venda entre sellers.
Anterior
Webhooks do Pagar.me
Próxima
Configuração do Braspag
Nesta página
  • Como funciona
  • Status do sub-lojista
  • Conceitos
  • Sandbox e produção
  • Segredos
  • Endpoints
  • Erros comuns
  • Próximos passos