Corpo da requisição
ID local do depósito concluído.
reasonstringMotivo, até 140 caracteres.
amountnumberOpcional. Deve coincidir com o valor bruto integral do depósito.
Headers
Identificador único de até 128 caracteres. Preserve a chave e o corpo ao repetir a operação.
Autorização
Chave VibeCash com permissão para esta operação.
Resposta
Indica se a operação foi concluída pela API.
Mensagem da operação.
Dados retornados pela operação.
Show child attributes
idstringIdentificador da operação.
statusstringSituação atual do pagamento ou envio.
amountnumberValor bruto ou informado, em reais.
feeAmountnumberTaxa da operação, em reais.
netAmountnumberLíquido da entrada ou total debitado de uma saída.
recipientAmountnumberValor entregue ao destinatário.
totalDebitnumberTotal debitado da carteira.
createdAtstringData e hora da criação em formato ISO.
requestIdstringIdentificador da requisição.
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"
}