Skip to main content
POST/refunds/create

Corpo da requisição

transactionIdstringrequired

ID local do depósito concluído.

reasonstring

Motivo, até 140 caracteres.

amountnumber

Opcional. Deve coincidir com o valor bruto integral do depósito.

Headers

Idempotency-Keystringrequired

Identificador único de até 128 caracteres. Preserve a chave e o corpo ao repetir a operação.

Autorização

X-API-Keystringrequired

Chave VibeCash com permissão para esta operação.

Resposta

202 application/json
successbooleanrequired

Indica se a operação foi concluída pela API.

messagestringrequired

Mensagem da operação.

dataobjectrequired

Dados retornados pela operação.

Show child attributes
idstring

Identificador da operação.

statusstring

Situação atual do pagamento ou envio.

amountnumber

Valor bruto ou informado, em reais.

feeAmountnumber

Taxa da operação, em reais.

netAmountnumber

Líquido da entrada ou total debitado de uma saída.

Valor entregue ao destinatário.

Total debitado da carteira.

createdAtstring

Data e hora da criação em formato ISO.

requestIdstring

Identificador da requisição.

A devolução é integral. O líquido creditado fica reservado enquanto o provedor confirma. A aceitação e a janela de devolução dependem do provedor.

Erros

As falhas retornam o envelope com success: false. Consulte erros e códigos HTTP para interpretar validação, permissão, conflito e saldo insuficiente.

curl --request POST \
  --url 'https://seu-dominio/v1/refunds/create' \
  --header 'X-API-Key: tp_live_SUA_CHAVE' \
  --header 'Idempotency-Key: operacao-unica-123' \
  --header 'Content-Type: application/json' \
  --data '{"transactionId":"pay_SEU_ID","reason":"Devolução solicitada pelo cliente"}'
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "id": "refund_exemplo",
    "amount": 5,
    "feeAmount": 0,
    "netAmount": 0,
    "recipientAmount": 0,
    "totalDebit": 4.9,
    "status": "PROCESSING",
    "createdAt": "2026-11-10T15:00:00.000Z"
  },
  "requestId": "req_exemplo"
}

Pesquisar documentação

POST

Solicitar reembolso PIX

Solicite a devolução integral de um depósito confirmado.

Authorization
Body
Expand 2 optional fields