Skip to main content
GET
List Refundable Deposits

Authorizations

Authorization
string
header
required

Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.

Path Parameters

customerId
string<uuid>
required

Unique identifier for the customer.

Query Parameters

includeRequested
boolean
default:false

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.

limit
integer
default:100

Maximum number of items to return.

Required range: x >= 1
offset
integer

Starting point to limit the total items to return (for pagination).

Required range: x >= 0

Response

Paginated list of the customer's refundable deposits.

Paginated list of a customer's refundable deposits.

count
integer

Total number of deposits across all pages.

next
string<uri> | null

URL to the next page of results. Null if no next page.

previous
string<uri> | null

URL to the previous page of results. Null if no previous page.

results
object[]

Array of refundable deposits for the customer.