Skip to main content
GET
Buscar refund por ID
GET /refunds/:id Faz parte do recurso Reembolsos — o objeto, os status e o ciclo estão lá.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID do refund

Response

Dados do refund

id
string

Identificador único do registro.

transactionId
string

ID da transação relacionada ao registro.

paymentId
string

ID do pagamento relacionado ao registro.

amount
integer

Valor em centavos.

currency
string

Moeda no padrão ISO 4217 (ex.: BRL).

status
string

Situação do reembolso. Valores: pending, approved, processing, refunded, refused, failed, awaiting_bank_details, bank_details_received, invalid_bank_details, ted_processing.

reason
string

Motivo informado para a operação.

requestedByType
string

Origem da solicitação: api, admin, customer ou gateway.

paymentMethod
string | null

Forma de pagamento (ex.: credit_card, pix, boleto).

customerId
string | null

Comprador da venda estornada (cust_), copiado da transação quando o estorno é criado. Nulo quando a transação não tem cliente.

customerName
string | null

Nome do comprador quando o estorno foi criado.

customerEmail
string | null

E-mail do comprador quando o estorno foi criado.

customerDocument
string | null

Documento do comprador (CPF ou CNPJ) quando o estorno foi criado.

customerDocumentType
string | null

Tipo do documento do comprador: cpf ou cnpj.

additionalInfo
object | null

Vínculo com a venda de origem, copiado da transação quando o estorno é criado. Nulo quando a venda foi criada direto pela API, sem link de checkout.

failureReason
string | null

Motivo da falha do processamento.

reviewedAt
string<date-time> | null

Data e hora em que a solicitação foi revisada (ISO 8601).

refundedAt
string<date-time> | null

Data e hora em que o estorno foi concluído (ISO 8601).

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).