Skip to main content
POST
Estornar cobrança
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.

Authorizations

Authorization
string
header
required

Token JWT obtido via POST /v1/login. Envie no header Authorization: Bearer <token>.

Headers

account
string
required

Código da conta à qual a operação se aplica

Example:

"acc_abc123xyz"

Path Parameters

code
string
required

Código único da cobrança a ser estornada

Example:

"chg_abc123"

Body

application/json
value
integer

Valor a ser estornado em centavos (opcional). Se omitido, o estorno é total. Ex: para estornar R$ 50,00, envie 5000.

Example:

5000

Response

Estorno realizado com sucesso

mensagem
string
Example:

"Operação realizada com sucesso"

erro
boolean
Example:

false

mensagenserro
string[]
Example:
codigoretorno
integer
Example:

200

id
string
Example:

"00000000-0000-0000-0000-000000000000"

data
any | null

Dados retornados pela operação (objeto, array ou vazio)