Skip to main content
POST
Estorna um pagamento de lançamento de conta bancária.

Authorizations

Authorization
string
header
required

Token da sessão no cabeçalho Authorization, no formato Bearer (mesmo esquema ApiKeyAuth do contrato).

Headers

x-company-id
string
required

company uuid

Path Parameters

id
string
required

Transaction ID

paymentId
string
required

Transaction Payment ID

Body

application/json

Motivo do estorno

reason
string

Response

o lançamento atualizado, como no GET /companies/transactions/{id}

amount
string
audit_logs
object[]
bank_account
object

BankAccount é PONTEIRO (CERNE-304/T4d): uma transação de cartão de crédito não tem conta bancária, e o contrato precisa expressar isso como null explícito no JSON — nunca {} (pareceria conta real de campos vazios) e nunca campo ausente (o front não distinguiria de versão antiga da API). Decisão registrada em plan.md, Q6.

category
object
competence
string
contact
string
cost_center
object

swaggertype: o swag v1.16 não resolve o alias dto2 (há quatro pacotes "dto" importados aqui) e o make swagger falhava. Só a doc fica genérica; o JSON é o mesmo.

created_at
string
created_by
object
credit_card
object

CreditCard é o espelho de BankAccount para a outra origem (CERNE-304 / T11): null explícito no lançamento de conta bancária, preenchido na compra de cartão. Campo NOVO e aditivo — quem já ignora o corpo não percebe, e quem lê origin sabe qual dos dois consultar.

due_date
string
id
string
more_infos
string
origin
string

Origin é o discriminador explícito da origem do lançamento — ver as constantes acima. Sempre presente, nunca vazio.

payment_date
string
payments
object[]
reference
string
status
string
supplier
object
tags
string[]
type
string
updated_at
string
url
string