> ## Documentation Index > Fetch the complete documentation index at: https://docs.ripio.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml ramps-api/openapi.json GET /api/v1/customers/{customerId}/refundableDeposits/ openapi: 3.1.0 info: title: Ripio Ramp API version: v1 description: >- API for Ripio ramp services, enabling partners to integrate On-Ramp, Off-Ramp, customer management, KYC processes, and other financial functionalities. This API is RESTful, uses JSON for requests and responses, and standard HTTP status codes. This document is based on the 'onramp-api.pdf' provided and aims to be compliant with OpenAPI Specification v3.1.0. The PDF indicates that the API documentation is a draft and subject to change. servers: - url: https://skala-sandbox.ripio.com description: Sandbox environment - url: https://skala.ripio.com description: Production environment security: - BearerToken: [] tags: - name: Authentication description: Operations related to API authentication and authorization. - name: Support Tickets description: >- Operations for raising and tracking customer support tickets with Ripio's support team. This feature must be enabled for your account by the Ripio team. - name: Customers description: Operations related to customer management. - name: KYC description: Operations related to Know Your Customer processes. - name: Fiat Accounts description: Operations related to managing fiat accounts and their requirements. - name: Quotes description: Operations related to obtaining and managing conversion quotes. - name: On-Ramp description: Operations related to fiat-to-crypto (on-ramp) processes. - name: Off-Ramp description: Operations related to crypto-to-fiat (off-ramp) processes. - name: Refunds description: >- Operations for returning the money of an on-ramp or off-ramp operation that could not be completed. Each ramp must be enabled for your account by the Ripio team. - name: Transactions description: Operations related to listing and managing all transaction types. - name: Networks description: >- Operations related to retrieving available deposit and withdrawal networks. - name: Rates description: Operations related to retrieving market rates. - name: Transaction Limits description: >- Operations related to retrieving per-transaction limits by currency and ramp operation. - name: Sandbox description: Operations specific to the sandbox environment for testing purposes. - name: Webhooks description: Webhook event notifications from Ripio Ramp API. - name: Sell and Pay description: >- Endpoints for managing Sell and Pay transactions, which allow customers to convert cryptocurrency to fiat currency and pay merchants via QR codes paths: /api/v1/customers/{customerId}/refundableDeposits/: get: tags: - Refunds summary: List Refundable Deposits description: >- 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. operationId: listRefundableDeposits parameters: - $ref: '#/components/parameters/CustomerId' - $ref: '#/components/parameters/IncludeRequested' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' responses: '200': description: Paginated list of the customer's refundable deposits. content: application/json: schema: $ref: '#/components/schemas/PaginatedRefundableDepositList' '401': description: Unauthorized - Invalid or missing access token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: 40001 type: NotAuthenticated detail: message: Authentication credentials were not provided. code: not_authenticated status: 401 '404': description: >- Not Found - the resource does not exist or does not belong to your account. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: 40004 type: NotFound detail: message: Not found. code: not_found status: 404 components: parameters: CustomerId: name: customerId in: path required: true description: Unique identifier for the customer. schema: type: string format: uuid example: 8142b065-79c4-4f48-9e33-11b17bc658d4 IncludeRequested: name: includeRequested in: query description: >- 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`. required: false schema: type: boolean default: false example: true Limit: name: limit in: query description: Maximum number of items to return. required: false schema: type: integer minimum: 1 default: 100 example: 100 Offset: name: offset in: query description: Starting point to limit the total items to return (for pagination). required: false schema: type: integer minimum: 0 example: 0 schemas: PaginatedRefundableDepositList: type: object description: Paginated list of a customer's refundable deposits. properties: count: type: integer description: Total number of deposits across all pages. next: type: - string - 'null' format: uri description: URL to the next page of results. Null if no next page. previous: type: - string - 'null' format: uri description: URL to the previous page of results. Null if no previous page. results: type: array items: $ref: '#/components/schemas/RefundableDeposit' description: Array of refundable deposits for the customer. ErrorResponse: type: object properties: code: type: integer description: Application-specific error code. type: type: string description: Type of error or exception. detail: type: - object - array description: >- Error details. The shape depends on the error: - Most business errors return an object with a `message` key. - Field validation errors return an object keyed by field name, each holding an array of `{ message, code }`. - Request-level validation errors (e.g. a missing query parameter) return a bare array of `{ message, code }`. properties: message: type: string description: Detailed error message. additionalProperties: true status: type: integer description: HTTP status code. required: - code - type - detail - status RefundableDeposit: type: object description: >- A fiat deposit that was received but never matched to an on-ramp order, and can still be refunded to the customer. properties: depositUuid: type: string format: uuid description: Identifier of the deposit, used to request its refund. amount: type: string description: Amount received. example: '150000.00' currency: type: string description: Currency of the deposit. example: COP paymentMethodType: type: string description: Payment method the deposit arrived through. example: bank_transfer createdAt: type: string format: date-time description: When the deposit was received. refundDestinationRequired: type: - boolean - 'null' description: >- Whether refunding this deposit requires naming a destination `fiatAccountId`. `false` means the money is returned to the account the customer paid from. `null` when the deposit's provider is outside the refund scope. latestRefund: anyOf: - $ref: '#/components/schemas/LatestFiatRefund' - type: 'null' description: >- State of the most recent refund of this deposit, or `null` if there never was one. On the default list it can only be a rejection, because a deposit whose refund is in progress or done is not listed. With `?includeRequested=true` it also carries the states of a refund still under way (`PENDING`, `PROCESSING`, `FAILED`, `CANCELLED`), which is what tells you whether the deposit can still be claimed or its refund is already being resolved. LatestFiatRefund: type: object description: >- State of the most recent refund of the order's deposit. The refund is not necessarily one you requested — Ripio may return a deposit on its own after a failed order — so read `initiatedBy` before presenting it as the customer's own request. properties: refundId: type: string format: uuid description: Unique identifier of the refund. status: type: string enum: - PENDING - PROCESSING - COMPLETED - REJECTED - FAILED - CANCELLED description: >- Current state of the refund: `PENDING` (registered, not yet sent to the provider), `PROCESSING` (sent, awaiting confirmation), `COMPLETED` (the money reached its destination), `REJECTED` (the request was declined — see `rejectionReason` — and nothing was sent) or `FAILED` / `CANCELLED` (the attempt did not go through; contact Ripio support). rejectionReason: type: string enum: - '' - DUPLICATE_REQUEST - INVALID_DESTINATION - ALREADY_RESOLVED - NOT_ELIGIBLE - CONTACT_SUPPORT description: Why the request was declined. Empty unless `status` is `REJECTED`. initiatedBy: type: string enum: - PARTNER - SYSTEM - OPS description: >- Who originated the refund: `PARTNER` (requested through the API), `SYSTEM` (returned automatically by Ripio) or `OPS` (registered by Ripio's support team). securitySchemes: BearerToken: type: http scheme: bearer bearerFormat: JWT description: >- Access token obtained via [/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as `Authorization: Bearer `. ````