Skip to main content
POST
Solicitar reembolso de transação

Autorizações

Authorization
string
header
obrigatório

Access token obtido no POST /auth (client_id + client_secret). Válido por 300 segundos.

Cabeçalhos

X-Sub-Account
string

Reference da subconta em que a operação deve ser executada. Quando omitido, a operação acontece na conta principal; o valor reservado principal também resolve para a conta principal e é equivalente a omitir o header. Aceito em todos os endpoints, exceto POST /auth e os próprios endpoints de /sub-accounts, que sempre operam na conta principal.

Erros possíveis: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Exige que a credencial tenha o acesso a subcontas habilitado (Configurações → Integração → Credenciais de API). Ele nasce desligado e não é substituído por nenhuma permissão, nem por FULL_ACCESS: sem ele a resposta é 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Exemplo:

"loja-centro"

Parâmetros de caminho

id
string<uuid>
obrigatório

ID da transação de pagamento a ser reembolsada

Corpo

application/json
reason
string

Motivo do reembolso (opcional, máximo 255 caracteres)

Maximum string length: 255
Exemplo:

"Cliente solicitou cancelamento"

Resposta

Reembolso solicitado com sucesso. Status PENDING até a confirmação via webhook.

originalTransactionId
string<uuid>
obrigatório

ID da transação original que está sendo reembolsada

pspProvider
string
obrigatório

Provedor PSP que processou o reembolso

pspRefundTransactionId
string
obrigatório

ID da transação de reembolso no PSP

status
enum<string>
obrigatório

Status retornado pelo PSP. PENDING significa que o reembolso foi aceito mas ainda não foi confirmado — a confirmação chega via webhook refund_completed.

Opções disponíveis:
PENDING,
CONFIRMED,
ERROR
Exemplo:

"PENDING"