Deposits

Refund a deposit

Refund all or part of a deposit's remaining balance to the client. If amount is omitted, the full remaining balance is refunded. Returns an error if the deposit is already fully refunded or if the requested amount exceeds the remaining balance.

post/v1/deposits/{depositId}/refund

Request

  • Base URL: https://api.frihet.io
  • URL: https://api.frihet.io/v1/deposits/{depositId}/refund
  • Auth: API key in header X-API-Key

Path parameters

depositIdstring required

Deposit unique identifier

Request body

amountnumber

Amount to refund. Omit to refund the full remaining balance.

Example request

{
  "amount": 250
}

Response

Deposit refunded successfully

successboolean
depositIdstring
refundedAmountnumber
remainingBalancenumber

Example response

{
  "success": true,
  "depositId": "dep_abc123",
  "refundedAmount": 250
}

Changes

No recorded changes to this operation across all 1 revision of this API.