Reembolso

Cria um reembolso para a invoice indicada. Ao criar a requisicao, voce pode informar o modo de calculo da taxa de reembolso usando o parametro fee_mode.

URL

Autorizacao obrigatoria

POST

https://api.fps.pro/invoices/refund/{id}

Formato da requisicaoapplication/json

fee_mode

number

Modo de cobranca da taxa. Se deduct for informado, a taxa sera descontada do valor do pagamento e o cliente recebera o valor da invoice com a taxa deduzida. Se add for informado, voce paga a taxa de reembolso pela conta do merchant e o cliente recebe o valor integral do pagamento.

Padrao: deduct

Exemplos de requisição

curl --request POST 'https://api.fps.pro/invoices/refund/0a718b02-138d-495a-9661-39ca52139c07' \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: YOUR_CLIENT_ID' \
  --header 'X-Timestamp: 1720000000' \
  --header 'X-Signature: YOUR_HMAC_SHA256_SIGNATURE' \
  --data '{
  "fee_mode": "deduct"
}'

Resposta bem-sucedida

{
  "status": 200,
  "message": "success refund"
}

Erros

A lista detalhada de erros de autorizacao esta em Autorizacao - Erros

{
  "status": 400,
  "message": "There is no balance available for refund"
}
{
  "status": 404,
  "message": "The invoice is not found"
}
{
  "status": 422,
  "message": "Validation Error",
  "errors": [
    {
      "field": "fee_mode",
      "message": "invalid value"
    }
  ]
}
{
  "status": 500,
  "message": "Internal Server Error"
}