List Refundable Deposits
Returns the customer’s fiat deposits that were received but never matched to an on-ramp order.
By default the list answers what can still be claimed: only the deposits a new refund can be requested for. A deposit whose refund is in progress or already completed is not listed; one whose previous request was rejected is, and its latestRefund carries the reason.
With ?includeRequested=true it answers where the customer’s money is: the same deposits plus the ones whose refund was already requested and has not been credited yet, each carrying its state in latestRefund. Use it to keep a payment visible on your screens while its refund is resolved, instead of having it disappear the moment the refund is requested. A deposit leaves the list only when its refund reaches COMPLETED — the money is back with the customer.
In that wider mode the presence of a deposit no longer means it can be claimed: read latestRefund to tell the two apart (null or REJECTED → a refund can be requested; any other state → one is already under way).
Both modes require on-ramp refunds to be enabled for your account. While they are not, the claimable half is left out of both: the endpoint answers 200 with no such deposits rather than offering ones a request would then reject with 403 / 20056. An empty page therefore does not mean the customer has no unmatched deposits. What ?includeRequested=true still returns in that case is any deposit whose refund Ripio support already started on the customer’s behalf.
Authorizations
Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.
Path Parameters
Unique identifier for the customer.
Query Parameters
Also list the deposits whose refund was already requested and has not been credited yet. Omit it (the default) to list only the deposits a new refund can be requested for. Any value other than true reads as false.
Maximum number of items to return.
x >= 1Starting point to limit the total items to return (for pagination).
x >= 0Response
Paginated list of the customer's refundable deposits.
Paginated list of a customer's refundable deposits.