[POST] /payment/refund/:id

Solicita o reembolso de uma transação

Para saber maisCopied!

Endpoint de produçãoCopied!

Método POST

https://api.firebanking.com.br/payment/refund/:id

RequisiçãoCopied!

Headers

Campo	Valor	Tipo	Descrição
Content-Type	application/json	string	Define o conteúdo como JSON
apiKey	123	string	Sua chave API

Parâmetros da rota

Campo	Obrigatório	Descrição
id	Sim	Identificador único da transação. Esta transação deve ter o status “PAID”, ou seja, uma cobrança que já foi paga. Deve ter no máximo 90 dias e haver saldo suficiente para devolução.

Campo

Obrigatório

Descrição

Sim

Identificador único da transação.

Esta transação deve ter o status “PAID”, ou seja, uma cobrança que já foi paga.

Deve ter no máximo 90 dias e haver saldo suficiente para devolução.

Campos a serem enviados no Body

Campo	Obrigatório	Tipo	Descrição
`value`	Não	number / float	O valor que deseja reembolsar, em caso de reembolso parcial. Caso deixe vazio, o reembolso será total. O valor máximo permitido é o valor da própria transação.
`description`	Não	string	A descrição que deseja exibir no comprovante de reembolso.

cURL

curl --request POST \
  --url https://api.firebanking.com.br/payment/refund/<id> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <sua-chave-api>'
  --data '{
	"value": 50.20,
	"description": "Sua descrição"
}'

Exemplo de respostaCopied!

Campos a serem recebidos

Campo	Tipo	Descrição
transactionId	string	Identificador único da transação

JSON

{
    "transactionId":"75906707-8c31-479c-b354-aa805c4cefbc"
}