Remboursement

Crée un remboursement pour la facture indiquée. Lors de la création de la requête, vous pouvez indiquer le mode de calcul des frais de remboursement avec le paramètre fee_mode.

URL

Autorisation requise

POST

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

Format de requêteapplication/json

fee_mode

number

Mode de facturation des frais. Si deduct est indiqué, les frais seront déduits du montant du paiement et le client recevra le montant de la facture déduction faite des frais. Si add est indiqué, vous payez les frais de remboursement depuis le compte marchand et le client reçoit le montant total du paiement.

Par défaut: deduct

Exemples de requête

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"
}'

Réponse réussie

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

Erreurs

La liste détaillée des erreurs d'autorisation se trouve dans Autorisation - Erreurs

{
  "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"
}