Após a criação de uma cobrança Pix, e efetivado o recebimento de um valor (cash-in), o recebedor pode realizar a devolução de uma quantia, sendo total ou parcial para o pagador.
O processo de devolução somente poderá ser realizado até 90 dias após a data do recebimento.
Requisição
PUT 'https://apisandbox.delbank.com.br/baas/api/v1/transactions/{transactionId}/refund?filterBy={filterBy}'
curl --location 'https://apisandbox.delbank.com.br/baas/api/v1/transactions/{transactionId}/refund?filterBy={filterBy}' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: ${apiKey}' \
--data '{
"description": "Pix recebido de forma errada",
"amount": 1
}}'
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
| x-delbank-api-key | Obrigatório. Chave de API |
Parâmetros da rota (Path)
| Nome | Tipo | Descrição |
|---|---|---|
| transactionId | string | Obrigatório. Identificação da transação |
Parâmetros da requisição (Query)
| Nome | Tipo | Descrição |
|---|---|---|
| filterBy | enum | Obrigatório. Informe qual o tipo de filtro que deve ser utilizado na busca da transação. Domínios: - CORRELATION_ID - Campo utilizado na criação da cobrança (cash-in)- END_TO_END_ID - Campo utilizado no recebimento de Pix- NSU - Campo utilizado para controle interno do Delbank |
Corpo da requisição (Body)
| Nome | Tipo | Descrição |
|---|---|---|
| amount | number | Obrigatório. Valor a ser devolvido |
| description | string | Descrição da transação |
Exemplos
Ao criar uma cobrança, é necessário informar um campo correlationId, e este é utilizado pelo sistema cliente a fim de permitir que realize busca da cobrança, pagamentos, etc. Uma vez que tenha recebido um pagamento de uma cobrança, é possível realizar a devolução da mesma informando o valor da correlationId e também é necessário informar no endpoint o campo filterBy com o valor CORRELATION_ID.
Segue abaixo o exemplo, caso queira realizar a devolução de um pagamento, cujo a cobrança criada possui correlationId igual à 3202309041323490YziIy
PUT 'https://apisandbox.delbank.com.br/baas/api/v1/transactions/3202309041323490YziIy/refund?filterBy=CORRELATION_ID'
{
"description": "Pix recebido incorretamente",
"amount": 1
}
Observação
Vale lembrar que processo de devolução pode utilizar a identificação da transação de três formas, podendo ser via:
correlationId,endToEndIdensu.
- O correlationId é o campo utilizado na geração das cobranças para realizar o processo de cash-in
- O endToEndId é o campo utilizando no processo do Pix
- O nsu é um campo interno do Delbank
Todas as informações acima são obtidas pelo extrato
Resposta (response)
O status code 200 indicará sucesso na transação.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
{
"id": "73efa4c7-9540-417a-b3cb-67e6936ab965",
"nsu": 999999134,
"amount": 1.0,
"notes": "Pix recebido de forma errada",
"createdAt": "2023-08-18T02:30:56.657Z",
"type": {
"name": "DEBIT_PIX_REFUND",
"description": "Devolução PIX Recebido",
"isCredit": false
},
"balance": {
"balancePrevious": 69696889086637.60,
"currentBalance": 69696889086636.60
},
"proof": {
"id": "73efa4c7-9540-417a-b3cb-67e6936ab965",
"endToEndId": "E99999003202309041323490YziIyKiU",
"status": "PIX_EFFECTIVE",
"type": "PIX_MANUAL",
"amount": 6.0,
"createdAt": "2023-08-04T10:23:48.924Z",
"description": "Pix recebido de forma errada",
"payer": {
"number": "826953",
"branch": "9162",
"type": "CURRENT",
"holder": {
"document": "12345678901234",
"name": "CENTRO DE SAUDE CREDILUZ LTDA",
"type": "LEGAL"
},
"participant": {
"name": "DELBANK",
"ispb": "38224857"
}
},
"beneficiary": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"holder": {
"document": "32752023000149",
"name": "bxxdbde",
"type": "LEGAL"
},
"participant": {
"name": "DELBANK",
"ispb": "38224857"
}
}
}
}