Skip to main content
POST

Corpo da requisição

string
required
ID interno da cobrança (clx_...) ou externalId (pay_...).
number
Valor parcial em reais; omita para estorno total.
string
Motivo do estorno (opcional).
Estorno disponível para cobranças com status RECEIVED ou CONFIRMED.

Authorizations

X-API-Key
string
header
required

Chave wp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json
id
string
required

paymentIntentId retornado no create

amount
number
Required range: x >= 0.01
reason
string

Response

Operação concluída.

success
boolean
required
Example:

true

message
string
required
Example:

"Operação concluída com sucesso"

data
object
required
requestId
string