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

Sub-lojistas Braspag

Cadastra, lista, consulta, atualiza e muda o status dos sellers como sub-lojistas na Braspag.

Para receber parte de uma venda no split, o seller precisa existir na Braspag como sub-lojista. Estas rotas fazem o cadastro (que chama a Braspag), guardam o vínculo com o seller da Venddor e acompanham a análise. A resposta de cadastro já traz o status devolvido pela Braspag; mudanças posteriores chegam por notificação da Braspag ou por ajuste manual aqui.

Listar sub-lojistas

GET/api/v1/admin/braspag/sellersAdmin

Lista sub-lojistas

Exemplo de requisição

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

Resposta

200Sub-lojistas
json
[
  {
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "vendor_id": "7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f",
    "subordinate_merchant_id": "b6f1c0aa-1111-4222-8333-444455556666",
    "status": "pending",
    "merchant_name": "Loja Exemplo Ltda",
    "cnpj": "12345678000195",
    "bank_code": "341",
    "bank_branch": "1234",
    "bank_account": "56789",
    "bank_account_digit": "0",
    "bank_account_type": "checking",
    "contact_name": "Maria Souza",
    "contact_email": "financeiro@lojaexemplo.com.br",
    "mdr_rate": 0,
    "commission_percent": 1000,
    "created_at": "2026-10-11T12:00:00Z",
    "updated_at": "2026-10-11T12:00:00Z"
  }
]

Campos da resposta

idstring
Id do registro de sub-lojista.
vendor_idstring
Id do seller na Venddor.
subordinate_merchant_idstring
Id na Braspag, vazio enquanto pendente.
statusstring
pendingapprovedrejectedsuspended
pending, approved, rejected ou suspended.
commission_percentinteger
Comissão em pontos-base.
mdr_rateinteger
Taxa MDR do seller em pontos-base.
created_atstring
Criação (RFC 3339).
updated_atstring
Última alteração (RFC 3339).
merchant_namestring
Razão social.
cnpjstring
CNPJ sem pontuação.
bank_codestring
Banco.
bank_branchstring
Agência.
bank_accountstring
Conta.
bank_account_digitstring
Dígito.
bank_account_typestring
Tipo de conta.
contact_namestring
Contato.
contact_emailstring
E-mail do contato.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O módulo braspag está desligado na loja.{"error":"module_disabled","module":"braspag"}
403O usuário não tem manage_payments nem view_payments.{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}
Sem paginação

Devolve todos os sub-lojistas da loja em um array na raiz.

Cadastrar um sub-lojista

Valida os dados, recusa seller já cadastrado e envia o cadastro à Braspag. Em sucesso responde 201.

POST/api/v1/admin/braspag/sellersAdmin

Cadastra um sub-lojista

Corpo da requisição

vendor_iduuidobrigatório
Id do seller (lojista) na Venddor. No PUT é ignorado: vale o do caminho.
merchant_namestringobrigatório
Razão social, como aparece na fatura do cartão.
cnpjstringobrigatório
CNPJ com 14 caracteres alfanuméricos; pontos, barra e hífen são removidos.
bank_codestringobrigatório
Código COMPE do banco (341 = Itaú).
bank_branchstringobrigatório
Agência.
bank_accountstringobrigatório
Conta, sem dígito.
bank_account_digitstringobrigatório
Dígito da conta.
bank_account_typestringobrigatório
checkingsavings
Tipo de conta.
contact_namestringobrigatório
Contato no seller.
contact_emailstringobrigatório
E-mail válido do contato.
commission_percentintegerpadrão: 0
Comissão do marketplace em pontos-base, de 0 a 10000 (1000 = 10%).

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/braspag/sellers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_id": "7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f",
    "merchant_name": "Loja Exemplo Ltda",
    "cnpj": "12.345.678/0001-95",
    "bank_code": "341",
    "bank_branch": "1234",
    "bank_account": "56789",
    "bank_account_digit": "0",
    "bank_account_type": "checking",
    "contact_name": "Maria Souza",
    "contact_email": "financeiro@lojaexemplo.com.br",
    "commission_percent": 1000
  }'

Resposta

201Cadastrado
json
{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "vendor_id": "7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f",
  "subordinate_merchant_id": "b6f1c0aa-1111-4222-8333-444455556666",
  "status": "pending",
  "created_at": "2026-10-11T12:00:00Z"
}

Campos da resposta

iduuid
Id do registro.
vendor_iduuid
Seller.
subordinate_merchant_idstring
Id na Braspag.
statusstring
pendingapprovedrejectedsuspended
Status inicial devolvido pela Braspag.
created_atstring
Criação.

Erros

StatusQuandoCorpo de exemplo
400Corpo não é um JSON válido.{"error":"invalid request body"}
401Sem token ou token inválido.{"error":"missing authorization header"}
403O módulo braspag está desligado na loja.{"error":"module_disabled","module":"braspag"}
403O usuário não tem manage_payments nem view_payments.{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}
422Validação ou erro da Braspag, incluindo seller já cadastrado. A mensagem vem em inglês.{"error":"braspag: invalid seller input: bank_account_type must be 'checking' or 'savings'"}

Consultar um sub-lojista

GET/api/v1/admin/braspag/sellers/{vendorId}Admin

Consulta um sub-lojista

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller na Venddor (não o id do registro).

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/braspag/sellers/7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Sub-lojista
json
{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "vendor_id": "7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f",
  "subordinate_merchant_id": "b6f1c0aa-1111-4222-8333-444455556666",
  "status": "pending",
  "merchant_name": "Loja Exemplo Ltda",
  "cnpj": "12345678000195",
  "bank_code": "341",
  "bank_branch": "1234",
  "bank_account": "56789",
  "bank_account_digit": "0",
  "bank_account_type": "checking",
  "contact_name": "Maria Souza",
  "contact_email": "financeiro@lojaexemplo.com.br",
  "mdr_rate": 0,
  "commission_percent": 1000,
  "created_at": "2026-10-11T12:00:00Z",
  "updated_at": "2026-10-11T12:00:00Z"
}

Campos da resposta

idstring
Id do registro de sub-lojista.
vendor_idstring
Id do seller na Venddor.
subordinate_merchant_idstring
Id na Braspag, vazio enquanto pendente.
statusstring
pendingapprovedrejectedsuspended
pending, approved, rejected ou suspended.
commission_percentinteger
Comissão em pontos-base.
mdr_rateinteger
Taxa MDR do seller em pontos-base.
created_atstring
Criação (RFC 3339).
updated_atstring
Última alteração (RFC 3339).
merchant_namestring
Razão social.
cnpjstring
CNPJ sem pontuação.
bank_codestring
Banco.
bank_branchstring
Agência.
bank_accountstring
Conta.
bank_account_digitstring
Dígito.
bank_account_typestring
Tipo de conta.
contact_namestring
Contato.
contact_emailstring
E-mail do contato.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O módulo braspag está desligado na loja.{"error":"module_disabled","module":"braspag"}
403O usuário não tem manage_payments nem view_payments.{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}
404O seller não tem cadastro Braspag.{"error":"no seller found for this vendor"}

Atualizar um sub-lojista

Atualiza dados bancários, contato e comissão na Braspag e no registro local. Exige todos os campos de novo, como no cadastro, e que o seller já tenha subordinate_merchant_id.

PUT/api/v1/admin/braspag/sellers/{vendorId}Admin

Atualiza um sub-lojista

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller na Venddor (não o id do registro).

Corpo da requisição

vendor_iduuidobrigatório
Id do seller (lojista) na Venddor. No PUT é ignorado: vale o do caminho.
merchant_namestringobrigatório
Razão social, como aparece na fatura do cartão.
cnpjstringobrigatório
CNPJ com 14 caracteres alfanuméricos; pontos, barra e hífen são removidos.
bank_codestringobrigatório
Código COMPE do banco (341 = Itaú).
bank_branchstringobrigatório
Agência.
bank_accountstringobrigatório
Conta, sem dígito.
bank_account_digitstringobrigatório
Dígito da conta.
bank_account_typestringobrigatório
checkingsavings
Tipo de conta.
contact_namestringobrigatório
Contato no seller.
contact_emailstringobrigatório
E-mail válido do contato.
commission_percentintegerpadrão: 0
Comissão do marketplace em pontos-base, de 0 a 10000 (1000 = 10%).

Exemplo de requisição

bash
curl -X PUT "$BASE_URL/api/v1/admin/braspag/sellers/7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_id": "7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f",
    "merchant_name": "Loja Exemplo Ltda",
    "cnpj": "12.345.678/0001-95",
    "bank_code": "341",
    "bank_branch": "1234",
    "bank_account": "56789",
    "bank_account_digit": "0",
    "bank_account_type": "checking",
    "contact_name": "Maria Souza",
    "contact_email": "financeiro@lojaexemplo.com.br",
    "commission_percent": 1000
  }'

Resposta

200Atualizado
json
{
  "status": "updated"
}

Erros

StatusQuandoCorpo de exemplo
400Corpo não é um JSON válido.{"error":"invalid request body"}
401Sem token ou token inválido.{"error":"missing authorization header"}
403O módulo braspag está desligado na loja.{"error":"module_disabled","module":"braspag"}
403O usuário não tem manage_payments nem view_payments.{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}
422Validação, seller sem cadastro ou ainda pendente sem id na Braspag, ou erro da Braspag.{"error":"braspag: seller for vendor 7e1d9c20-... has no subordinate_merchant_id (still pending?)"}

Mudar o status

Grava o status no registro local (aprovar, reprovar, suspender). Não chama a Braspag: é um ajuste do lado da plataforma.

PATCH/api/v1/admin/braspag/sellers/{vendorId}/statusAdmin

Muda o status do sub-lojista

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller na Venddor (não o id do registro).

Corpo da requisição

statusstringobrigatório
pendingapprovedrejectedsuspended
Novo status.

Exemplo de requisição

bash
curl -X PATCH "$BASE_URL/api/v1/admin/braspag/sellers/7e1d9c20-3b3b-4f8e-9f10-1a2b3c4d5e6f/status" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "suspended"
  }'

Resposta

200Atualizado
json
{
  "status": "updated"
}

Erros

StatusQuandoCorpo de exemplo
400Status fora da lista ou corpo inválido.{"error":"invalid status: must be 'pending', 'approved', 'rejected', or 'suspended'"}
401Sem token ou token inválido.{"error":"missing authorization header"}
403O módulo braspag está desligado na loja.{"error":"module_disabled","module":"braspag"}
403O usuário não tem manage_payments nem view_payments.{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}
422Seller sem cadastro Braspag.{"error":"braspag: no seller found for vendor 7e1d9c20-..."}
O status é só da plataforma

Mudar o status aqui não suspende o sub-lojista na Braspag. Ele serve para a plataforma saber quem pode receber split quando a divisão é calculada automaticamente (somente approved).

Veja também

  • Braspag
Anterior
Captura com split
Próxima
Assinaturas e compras programadas
Nesta página
  • Listar sub-lojistas
  • Exemplo de requisição
  • Resposta
  • Erros
  • Cadastrar um sub-lojista
  • Exemplo de requisição
  • Resposta
  • Erros
  • Consultar um sub-lojista
  • Exemplo de requisição
  • Resposta
  • Erros
  • Atualizar um sub-lojista
  • Exemplo de requisição
  • Resposta
  • Erros
  • Mudar o status
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também