Fiat Payments

Estimate refund fee

Returns the estimated processing fee and the maximum remaining refundable balance for the pay-in. The fee will be deducted from your wallet when issuing a refund. The fee amount may vary depending on the merchant contract with BVNK.

post/payment/v1/payins/{transactionReference}/refund/estimate

Request

Path parameters

transactionReferencestring uuid required
Example:023e5e53-6f50-4af5-a7e4-c9f15d493f90

Unique reference (UUID) of the pay-in you plan to refund.

Request body

valuenumber required

Amount in major currency units that will be refunded. Use dot as decimal separator.

currency'GBP' | 'USD' | 'EUR' required

Three-letter ISO-4217 currency code.

Example request

{
  "value": 150.5,
  "currency": "EUR"
}

Response

Fee estimate returned successfully.

Example response

{
  "fee": {
    "value": 1,
    "currency": "EUR"
  },
  "maxAvailableToRefund": {
    "value": 150,
    "currency": "EUR"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.