Estornar Cobrança (Total)

Estornar cobrança

patch

https://api.barte.comhttps://sandbox-api.barte.com

/v2/charges/{uuid}/refund

Realiza o estorno total de uma cobrança

Authorizations

ApiKeyAuth

X-Token-ApistringRequired

Token de autenticação para acesso à API

Path parameters

uuidstring · uuidRequired

UUID da cobrança a ser estornada

Header parameters

X-Token-ApistringRequired

Token de autenticação para acesso à API

Content-Typestring · enumRequired

Tipo de conteúdo da requisição

Possible values:

x-idempotency-keystringOptional

Chave de idempotência

x-ip-origin-requeststringOptional

IP de origem da requisição

Body

application/json

asFraudbooleanRequired

Indica se o estorno é devido a fraude

Responses

200

Estorno processado com sucesso

application/json

uuidstring · uuidOptionalExample: 5df05ef4-2c66-4984-a760-ead83024e811

titlestringOptionalExample: Teste

expirationDatestring · dateOptionalExample: 2025-09-20

paidDatestring · dateOptionalExample: 2025-09-20

valuenumber · doubleOptionalExample: 100

paymentMethodstring · enumOptionalExample: CREDIT_CARD_EARLY_SELLERPossible values:

statusstring · enumOptionalExample: REFUNDPossible values:

authorizationCodestring · nullableOptional

authorizationNsustringOptionalExample: 147163

retryablebooleanOptionalExample: false

201

Estorno criado com sucesso

application/json

202

Requisição aceita para processamento

204

Sem conteúdo

301

Redirecionamento permanente

400

Erro de validação

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

404

Cobrança não encontrada

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

patch

/v2/charges/{uuid}/refund

HTTPcURLJavaScriptPython

PATCH /v2/charges/{uuid}/refund HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "asFraud": true
}

{
  "uuid": "5df05ef4-2c66-4984-a760-ead83024e811",
  "title": "Teste",
  "expirationDate": "2025-09-20",
  "paidDate": "2025-09-20",
  "value": 100,
  "paymentMethod": "CREDIT_CARD_EARLY_SELLER",
  "status": "REFUND",
  "customer": {
    "uuid": "",
    "document": "001052647",
    "type": "SSN",
    "name": "Joshua Henry",
    "email": "[email protected]",
    "phone": "9409822523",
    "alternativeEmail": ""
  },
  "authorizationCode": null,
  "authorizationNsu": "147163",
  "retryable": false
}