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

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
  }'

Resposta

200Capturado

json

{
  "status": "captured"
}

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
500	A Braspag recusou ou houve falha de rede. Sem detalhe na resposta.	`{"error":"failed to capture payment"}`

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

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
  }'

Resposta

200Cancelado

json

{
  "status": "voided"
}

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
500	A 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

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
  }'

Resposta

200Estornado

json

{
  "status": "refunded"
}

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
500	A Braspag recusou (por exemplo, pagamento ainda não capturado) ou houve falha de rede.	`{"error":"failed to refund payment"}`

Veja também

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.

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

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
  }'

Resposta

200Capturado

json

{
  "status": "captured"
}

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
500	A Braspag recusou ou houve falha de rede. Sem detalhe na resposta.	`{"error":"failed to capture payment"}`

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

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
  }'

Resposta

200Cancelado

json

{
  "status": "voided"
}

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
500	A 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

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
  }'

Resposta

200Estornado

json

{
  "status": "refunded"
}

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O módulo `braspag` está desligado na loja.	`{"error":"module_disabled","module":"braspag"}`
403	O usuário não tem `manage_payments` nem `view_payments`.	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
500	A Braspag recusou (por exemplo, pagamento ainda não capturado) ou houve falha de rede.	`{"error":"failed to refund payment"}`