Deposits

GET /v2/deposits

List deposits

Parameters

Parameter	In	Type	Required	Description
page	query	integer	no	Default: 1.
limit	query	integer	no	Default: 25.
assetSymbol	query	string	no
status	query	string	no
subType	query	INTERNAL | EXTERNAL_CRYPTO | EXTERNAL_FIAT_BANK | EXTERNAL_FIAT_REDPAY_CHARGEBACK	no
startDate	query	string	no	ISO-8601 start date.
endDate	query	string	no	ISO-8601 end date.

Responses

Code	Description	Body
200	Success.	data: DepositResource[] · pagination: PaginationMeta
401	application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable).	—
403	application/problem+json (RFC 9457) — branch on code, not on the status: insufficient_scope (not retryable), ip_not_allowed (not retryable), api_access_disabled (not retryable).	—
429	application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable).	—
500	application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).	—
502	application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable).	—
503	application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable).	—

---

GET /v2/deposits/{id}

Get a deposit by id

Parameters

Parameter	In	Type	Required	Description
id	path	string	yes

Responses

Code	Description	Body
200	Success.	DepositResource
401	application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable).	—
403	application/problem+json (RFC 9457) — branch on code, not on the status: insufficient_scope (not retryable), ip_not_allowed (not retryable), api_access_disabled (not retryable).	—
404	application/problem+json (RFC 9457) — branch on code, not on the status: not_found (not retryable).	—
429	application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable).	—
500	application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).	—
502	application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable).	—
503	application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable).	—

---

Schemas

DepositResource

Field	Type	Description
id	string	Deposit id. Use it to re-fetch this deposit and to match its ledger entry (source.id).
type	string	e.g. DEPOSIT.
subType	INTERNAL | EXTERNAL_CRYPTO | EXTERNAL_FIAT_BANK | EXTERNAL_FIAT_REDPAY_CHARGEBACK
assetSymbol	string	Asset code of the deposit. e.g. BTC.
amount	string	Amount deposited. Positive magnitude, in assetSymbol.
fee	string	Fee charged by Skipo for this deposit. Always zero — Skipo does not charge deposit fees. Present for a consistent shape across resources. e.g. 0.
total	string	Total credited to the balance. Positive magnitude, in assetSymbol.
status	string
createdAt	string
depositData	object	Sub-type-specific details.

PaginationMeta

Field	Type	Description
page	number	e.g. 1.
limit	number	e.g. 25.
totalItems	number	e.g. 100.
totalPages	number	e.g. 4.

Problem

Field	Type	Description
type	string	Stable problem-type URI. Resolves to docs for this error. e.g. https://docs.skipo.com/errors/rate_limited.
title	string	Short, human-readable summary (stable, English). e.g. Rate limit exceeded.
status	number	HTTP status code. e.g. 429.
code	string	Stable machine-readable error code (equals the last path segment of type). e.g. rate_limited.
retryable	boolean	Whether retrying the identical request may succeed. e.g. true.
detail (optional)	string	Human-readable, possibly localized detail.
instance (optional)	string	The request path that produced the error.
traceId (optional)	string	Trace id — joins BigQuery api_request and Cloud Logging.

---

Back to the endpoint reference. See also: Pagination · Errors · Ids and correlation.