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

Configuração do Braspag

Lê e grava as credenciais da Braspag da loja e testa a conexão com o gateway.

Cada loja tem uma única configuração Braspag. Quando nada foi gravado, a leitura mostra os valores padrão do servidor.

Ler a configuração

GET/api/v1/admin/braspag/configAdmin

Lê a configuração

Exemplo de requisição

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

Resposta

200Configuração (segredos mascarados)
json
{
  "id": 1,
  "merchant_id": "00000000-0000-0000-0000-000000000001",
  "merchant_key": "****ABCD",
  "client_id": "minha-loja",
  "client_secret": "****wxyz",
  "environment": "sandbox",
  "enabled": true,
  "created_at": "2026-10-01T12:00:00Z",
  "updated_at": "2026-10-11T12:00:00Z"
}

Campos da resposta

idinteger
1 depois de gravada (há uma configuração por loja); 0 enquanto valem os padrões do servidor.
merchant_idstring
MerchantId da Braspag.
merchant_keystring
MerchantKey. Na leitura vem mascarado.
client_idstring
ClientId OAuth2 (split e cadastro de sub-lojistas).
client_secretstring
ClientSecret. Na leitura vem mascarado.
environmentstring
sandboxproduction
sandbox ou production.
enabledboolean
Se a integração está ativa.
created_atstring
Criação (RFC 3339). Pode vir sem valor se a loja usa os padrões do servidor.
updated_atstring
Última alteração (RFC 3339).

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"]}

Gravar a configuração

Substitui a configuração inteira: todos os campos são gravados como enviados, então envie também os que não mudaram. Campo omitido vira vazio (enabled omitido vira false).

PUT/api/v1/admin/braspag/configAdmin

Grava a configuração

Corpo da requisição

merchant_idstring
MerchantId.
merchant_keystring
MerchantKey.
client_idstring
ClientId OAuth2.
client_secretstring
ClientSecret.
environmentstring
sandboxproduction
sandbox ou production. Vazio é tratado como sandbox.
enabledboolean
Liga ou desliga a integração.

Exemplo de requisição

bash
curl -X PUT "$BASE_URL/api/v1/admin/braspag/config" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchant_id": "00000000-0000-0000-0000-000000000001",
    "merchant_key": "chave-secreta-exemplo",
    "client_id": "minha-loja",
    "client_secret": "segredo-exemplo",
    "environment": "sandbox",
    "enabled": true
  }'

Resposta

200Configuração gravada
json
{
  "id": 1,
  "merchant_id": "00000000-0000-0000-0000-000000000001",
  "merchant_key": "chave-secreta-exemplo",
  "client_id": "minha-loja",
  "client_secret": "segredo-exemplo",
  "environment": "sandbox",
  "enabled": true,
  "created_at": "2026-10-01T12:00:00Z",
  "updated_at": "2026-10-11T12:00:00Z"
}

Campos da resposta

idinteger
Sempre 1: há uma configuração por loja.
merchant_idstring
MerchantId da Braspag.
merchant_keystring
MerchantKey. Na leitura vem mascarado.
client_idstring
ClientId OAuth2 (split e cadastro de sub-lojistas).
client_secretstring
ClientSecret. Na leitura vem mascarado.
environmentstring
sandboxproduction
sandbox ou production.
enabledboolean
Se a integração está ativa.
created_atstring
Criação (RFC 3339). Pode vir sem valor se a loja usa os padrões do servidor.
updated_atstring
Última alteração (RFC 3339).

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"]}
500Falha ao gravar.{"error":"failed to update braspag configuration"}
A resposta do PUT devolve os segredos sem máscara

Diferente do GET, a resposta do PUT traz merchant_key e client_secret em texto puro. Não registre essa resposta em logs nem a repasse a um front-end.

Reenviar a configuração mascarada apaga o segredo

O GET devolve ****ABCD. Se você gravar esse valor de volta, ele vira a chave. Para alterar só um campo, envie as chaves reais.

Testar a conexão

Tenta autenticar na Braspag com a configuração gravada. Não altera nada.

POST/api/v1/admin/braspag/test-connectionAdmin

Testa a conexão

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/braspag/test-connection" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Conexão ok
json
{
  "status": "ok"
}

Erros

StatusQuandoCorpo de exemplo
400Credenciais recusadas ou ausentes. A mensagem é fixa, em inglês.{"error":"connection test failed; check MerchantID and MerchantKey configuration","status":"failed"}
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"]}

Veja também

  • Braspag
Anterior
Braspag
Próxima
Capturar, cancelar e estornar
Nesta página
  • Ler a configuração
  • Exemplo de requisição
  • Resposta
  • Erros
  • Gravar a configuração
  • Exemplo de requisição
  • Resposta
  • Erros
  • Testar a conexão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também