Estornar Cobrança (Total)

Solicitar estorno POS

patch

/v2/charges/{uuid}/pos/refund

Realiza o estorno de uma transação de maquininha (POS)

Authorizations

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 API para validação externa

Body

valuenumber · doubleRequired

Valor a ser estornado (deve ser o valor total disponível)

Example: 100.5

updated_bystringRequired

Identificação do usuário que está solicitando o estorno

Example: [e-mail]

Responses

200

Estorno solicitado com sucesso

application/json

uuidstring · uuidOptionalExample: ecb7df04-6f4d-49de-a26b-95182ce637d0

originalValuenumber · doubleOptionalExample: 1400

valuenumber · doubleOptionalExample: 1400

statusstring · enumOptionalExample: PROCESSINGPossible values:

failed_reasonstringOptional

400

Erro de validação

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

404

Recurso não encontrado

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

patch/v2/charges/{uuid}/pos/refund

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

{
  "value": 100.5,
  "updated_by": "[e-mail]"
}

{
  "uuid": "ecb7df04-6f4d-49de-a26b-95182ce637d0",
  "originalValue": 1400,
  "value": 1400,
  "status": "PROCESSING",
  "failed_reason": ""
}