Withdrawals

GET /v2/withdrawals

List withdrawals

Parámetros

Parámetro	En	Tipo	Requerido	Descripción
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 | NETWORK_FEE | TRANSFER_FEE	no
assetFormat	query	base | rebased	no	How to express tokenised-equity (xStock) amounts. rebased (default) = underlying equity; base = settled SPV tokens. No effect on other assets. Default: rebased.
startDate	query	string	no	ISO-8601 start date.
endDate	query	string	no	ISO-8601 end date.

Respuestas

Código	Descripción	Cuerpo
200	Éxito.	data: WithdrawalResource[] · 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).	—

---

POST /v2/withdrawals

Create a withdrawal

Money movement — requires a Tier-2 signed request (X-API-Key header + signed Authorization JWT), not a bare bearer key.

Autenticación: Petición firmada (Tier-2)

Cuerpo de la petición — CreateWithdrawalDto

Respuestas

Código	Descripción	Cuerpo
201	Creado.	WithdrawalResource
400	application/problem+json (RFC 9457) — branch on code, not on the status: validation_error (not retryable).	—
401	application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable), invalid_signature (not retryable), clock_skew (retryable), nonce_reused (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), two_factor_required (not retryable).	—
422	application/problem+json (RFC 9457) — branch on code, not on the status: unprocessable (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/withdrawals/{id}

Get a withdrawal by id

Parámetros

Parámetro	En	Tipo	Requerido	Descripción
id	path	string	sí

Respuestas

Código	Descripción	Cuerpo
200	Éxito.	WithdrawalResource
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).	—

---

Esquemas

CreateWithdrawalDto

Campo	Tipo	Descripción
assetSymbol	string	Asset to withdraw. Ej.: BTC.
amount	string	Amount to withdraw, as a positive decimal string. The withdrawal fee is charged on top — the balance is debited amount + fee. Ej.: 0.05.
contactId (opcional)	string	Destination contact id (a whitelisted address/account).
contactReference (opcional)	string	Destination contact reference/alias.

PaginationMeta

Campo	Tipo	Descripción
page	number	Ej.: 1.
limit	number	Ej.: 25.
totalItems	number	Ej.: 100.
totalPages	number	Ej.: 4.

Problem

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

WithdrawalResource

Campo	Tipo	Descripción
id	string	Withdrawal id. Use it to re-fetch this withdrawal and to match its ledger entry (source.id).
type	string	Ej.: WITHDRAWAL.
subType	INTERNAL | EXTERNAL_CRYPTO | EXTERNAL_FIAT_BANK | EXTERNAL_FIAT_REDPAY | NETWORK_FEE | TRANSFER_FEE
assetSymbol	string	Asset code of the withdrawal. Ej.: BTC.
amount	string	Amount withdrawn, excluding the fee. Positive magnitude, in assetSymbol.
fee	string	The withdrawal fee charged by Skipo, in assetSymbol. A flat fee — NOT the blockchain network fee, which Skipo absorbs. Positive magnitude.
total	string	Total debited from the balance (amount + fee). Positive magnitude, in assetSymbol.
status	string
createdAt	string
withdrawalData	object	Sub-type-specific details.

---

Volver a la referencia de endpoints. Ver también: Paginación · Errores · Ids y correlación.