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

Capturar, cancelar e estornar

Operações sobre um pagamento da Braspag já criado: captura, cancelamento antes da captura e estorno depois dela.

Um pagamento de cartão passa por autorização (o limite é reservado) e captura (o dinheiro é efetivamente cobrado). Cancelar desfaz uma autorização ou captura do mesmo dia; estornar devolve um valor já capturado. As três operações aceitam um valor parcial em centavos; sem corpo, valem pelo total.

Capturar

PUT/api/v1/admin/braspag/payments/{paymentId}/captureAdmin

Captura um pagamento

Parâmetros de caminho

paymentIduuidobrigatório
GUID do pagamento na Braspag.

Corpo da requisição

amountinteger
Valor em centavos para operação parcial. Omitido ou 0 = valor total.

Exemplo de requisição

Resposta

200Capturado

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"]}
500A Braspag recusou ou houve falha de rede. Sem detalhe na resposta.{"error":"failed to capture payment"}
Corpo opcional

O corpo é opcional e um JSON inválido é ignorado em silêncio: a captura sai total. Para capturar parcial, confira que o JSON está correto.

Cancelar

PUT/api/v1/admin/braspag/payments/{paymentId}/voidAdmin

Cancela um pagamento

Parâmetros de caminho

paymentIduuidobrigatório
GUID do pagamento na Braspag.

Corpo da requisição

amountinteger
Valor em centavos para operação parcial. Omitido ou 0 = valor total.

Exemplo de requisição

Resposta

200Cancelado

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"]}
500A Braspag recusou ou houve falha de rede.{"error":"failed to void payment"}

Estornar

POST/api/v1/admin/braspag/payments/{paymentId}/refundAdmin

Estorna um pagamento

Parâmetros de caminho

paymentIduuidobrigatório
GUID do pagamento na Braspag.

Corpo da requisição

amountinteger
Valor em centavos para operação parcial. Omitido ou 0 = valor total.

Exemplo de requisição

Resposta

200Estornado

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"]}
500A Braspag recusou (por exemplo, pagamento ainda não capturado) ou houve falha de rede.{"error":"failed to refund payment"}
Estorno da Braspag não muda o pedido

Estas rotas falam só com a Braspag. Para registrar o estorno no pedido da loja (status, estoque, comunicação com o cliente), use o fluxo de reembolso do pedido.

Veja também

  • Pedidos: reembolsos
  • Braspag
Anterior
Configuração do Braspag
Próxima
Captura com split
Nesta página
  • Capturar
  • Exemplo de requisição
  • Resposta
  • Erros
  • Cancelar
  • Exemplo de requisição
  • Resposta
  • Erros
  • Estornar
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também
bash
curl -X PUT "$BASE_URL/api/v1/admin/braspag/payments/3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11/capture" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 4990
  }'
bash
curl -X PUT "$BASE_URL/api/v1/admin/braspag/payments/3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11/void" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 4990
  }'
bash
curl -X POST "$BASE_URL/api/v1/admin/braspag/payments/3a1f2c7e-9d0b-4e55-8a2a-0c9d5a6b7e11/refund" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1500
  }'
json
{
  "status": "captured"
}
json
{
  "status": "voided"
}
json
{
  "status": "refunded"
}