> ## Documentation Index
> Fetch the complete documentation index at: https://docs.4seletpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Estornar Cobrança
> Realiza o estorno (reembolso) de uma cobrança aprovada. O campo `value` no body é opcional; se não informado, o estorno é total. O valor deve ser enviado em **centavos**.
Requer o header `account`. Apenas cobranças com status `Approved` podem ser estornadas.
Para estorno parcial, informe o campo `value` no body com o valor em **centavos** (inteiro). Ex: para estornar R\$ 50,00, envie `"value": 5000`.
Para estorno total, omita o campo `value` ou não envie body.
O prazo e as condições para estorno dependem do gateway de pagamento utilizado.
## OpenAPI
````yaml POST /v1/charge/refund/{code}
openapi: 3.1.0
info:
title: 4Selet Pay API
description: >
API de processamento de pagamentos da plataforma 4Selet Pay. Suporta
cobranças únicas, assinaturas recorrentes, PIX, Cartão de Crédito. Todas as
rotas autenticadas requerem um Bearer Token obtido via `/v1/login`.
version: 1.0.0
contact:
name: 4Selet Pay
email: suporte@4selet.com.br
servers:
- url: https://sandbox.4seletpay.com.br/api
description: Servidor de Sandbox
security:
- bearerAuth: []
tags:
- name: Autenticação
description: Rotas de autenticação e criação de usuários
- name: Cobranças
description: Criação, consulta, cancelamento e reembolso de cobranças
- name: Pedidos
description: Consulta de pedidos e gerenciamento de confirmações desafiadas
- name: Assinaturas
description: Criação e gerenciamento de assinaturas recorrentes
- name: Faturas
description: Gerenciamento de faturas e pagamento de faturas em atraso
- name: Clientes Bloqueados
description: Gerenciamento de lista negra de clientes
- name: Contas
description: Criação e gerenciamento de contas na plataforma
- name: Aplicativo
description: Endpoints para dashboard e uso via aplicativo mobile
- name: Notificações Push
description: Envio e gerenciamento de notificações push
- name: Utilitários
description: Endpoints utilitários como listagem de fusos horários
- name: Gestão
description: Relatórios gerenciais (acesso restrito a Super Admins)
- name: Webhooks
description: Endpoints para receber notificações de gateways de pagamento
- name: Endpoints de Webhook
description: >-
Gerenciamento de endpoints de webhook para receber notificações de eventos
da plataforma
- name: Links de Pagamento
description: Criação e gerenciamento de links de pagamento com checkout pré-configurado
paths:
/v1/charge/refund/{code}:
post:
tags:
- Cobranças
summary: Estornar cobrança
description: >
Realiza o estorno (reembolso) de uma cobrança aprovada. O campo `value`
no body é opcional; se não informado, o estorno é total. O valor deve
ser enviado em **centavos**.
operationId: refundCharge
parameters:
- $ref: '#/components/parameters/AccountHeader'
- name: code
in: path
required: true
description: Código único da cobrança a ser estornada
schema:
type: string
example: chg_abc123
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
value:
type: integer
description: >
Valor a ser estornado em centavos (opcional). Se omitido, o
estorno é total. Ex: para estornar R$ 50,00, envie 5000.
example: 5000
example:
value: 5000
responses:
'200':
description: Estorno realizado com sucesso
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
example:
mensagem: Cobrança chg_abc123 estornada com sucesso
erro: false
mensagenserro: []
codigoretorno: 200
id: 00000000-0000-0000-0000-000000000000
data: []
'400':
description: Erro no estorno (cobrança já estornada ou valor excede o disponível)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
ja_estornada:
summary: Cobrança já estornada por completo
value:
mensagem: Um erro inesperado acabou de acontecer.
erro: true
mensagenserro: []
codigoretorno: 400
id: 00000000-0000-0000-0000-000000000000
data: []
valor_excede:
summary: Valor excede o disponível para estorno
value:
mensagem: Um erro inesperado acabou de acontecer.
erro: true
mensagenserro: []
codigoretorno: 400
id: 00000000-0000-0000-0000-000000000000
data: []
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- bearerAuth: []
components:
parameters:
AccountHeader:
name: account
in: header
required: true
description: Código da conta à qual a operação se aplica
schema:
type: string
example: acc_abc123xyz
schemas:
SuccessResponse:
type: object
properties:
mensagem:
type: string
example: Operação realizada com sucesso
erro:
type: boolean
example: false
mensagenserro:
type: array
items:
type: string
example: []
codigoretorno:
type: integer
example: 200
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
description: Dados retornados pela operação (objeto, array ou vazio)
nullable: true
ErrorResponse:
type: object
properties:
mensagem:
type: string
example: Um erro inesperado acabou de acontecer.
erro:
type: boolean
example: true
mensagenserro:
type: array
items:
type: string
example:
- Detalhe do erro ocorrido.
codigoretorno:
type: integer
example: 400
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
type: array
example: []
responses:
Unauthorized:
description: Não autorizado — token inválido ou ausente
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: Unauthenticated.
erro: true
mensagenserro: []
codigoretorno: 401
id: 00000000-0000-0000-0000-000000000000
data: []
NotFound:
description: Recurso não encontrado
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: The charge code does not match any charge
erro: true
mensagenserro: []
codigoretorno: 404
id: 00000000-0000-0000-0000-000000000000
data: []
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Token JWT obtido via `POST /v1/login`. Envie no header `Authorization:
Bearer `.
````