Skip to main content
POST
Solicitar reembolso (assíncrono)

Authorizations

X-Api-Client-Token
string
header
required

Token de autenticação do cliente obtido via endpoint /auth

Path Parameters

transaction_hash
string
required

Hash da transação

Body

application/json
observation
string

Observação que ficará registrada no reembolso

reason
string

Motivo do reembolso enviado ao serviço de pagamentos

Maximum string length: 1000
fraud_confirmed
boolean

Indica se a solicitação é referente a fraude confirmada

refund_type
string

Tipo do reembolso quando aplicável

cancel_subscription
boolean | null

Se deve cancelar a assinatura vinculada à transação junto com o reembolso. Quando não informado e a transação possui assinatura, o valor padrão é true.

user_id
string | null

Código (hash) do usuário associado ao reembolso. Deve ser um código válido de um usuário ativo (não excluído).

Example:

"XXWBD7UOKM1756304064"

Response

Reembolso já existente retornado

status
string
required
Example:

"success"

message
string
required
Example:

"Reembolso processado com sucesso"

data
object
required