API reference · Withdrawals
List withdrawals
GET/v1/withdrawals
Bank and crypto withdrawals from every channel, newest first. from and to may be at most 366 days apart.
- Scope
transactions:readorwithdrawals:create- Rate-limit class
read- Authentication
- Signed
Parameters
typestring (enum)queryoptionalstatusstring (enum)queryoptionalawaiting_confirmation: a crypto withdrawal waiting for the link in the confirmation email; expired: that link was not used in time; pending: being processed; completed: sent; canceled; failed.
assetstringqueryoptionalAn upper-case asset symbol.
fromstring (date-time)queryoptionaltostring (date-time)queryoptionallimitintegerqueryoptionalPage size, 1 to 100. Default 50.
cursorstringqueryoptionalnext_cursor from the previous page.
Responses
200 OK
A page of withdrawals. application/json · WithdrawalList
dataarray of Withdrawal15 properties of each item
idstringtypestring (enum)statusstring (enum)awaiting_confirmation: a crypto withdrawal waiting for the link in the confirmation email; expired: that link was not used in time; pending: being processed; completed: sent; canceled; failed.
assetstringAn upper-case asset symbol.
networkstring | nullCrypto only.
amountstring (decimal)Taken from the balance, fee included.
feestring (decimal)nullableThe withdrawal fee in the asset; null when it isn't known yet.
addressstring | nullCrypto only.
memostring | nullbank_accountstring | nullBank only.
tx_idstring | nullThe blockchain transaction id, once sent.
sourcestring (enum)Where the record was made: this API, the mobile app or the webapp.
created_atstring (date-time)confirm_bystring (date-time)nullableFor awaiting_confirmation: the confirmation email's link works until this time.
completed_atstring (date-time)nullable
next_cursorstringnullablePass as cursor for the next page; null at the end.
Every response carries MK-Request-Id, plus RateLimit-Policy and RateLimit.
Errors
Errors use the error envelope. Match on code.
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | The request is malformed: bad JSON, an unknown or invalid field, or a missing header. |
| 401 | invalid_signature | The MK-* headers are missing or malformed, the key id is unknown, or the signature doesn't match. |
| 401 | key_expired | The key has passed its expiry date. |
| 401 | key_revoked | The key was revoked. |
| 401 | timestamp_out_of_range | MK-Timestamp is more than 30 seconds from the server clock. |
| 401 | nonce_reused | This key already used this MK-Nonce. |
| 403 | ip_not_allowed | The request came from an address outside the key's IP allowlist. |
| 403 | insufficient_scope | The key doesn't have the scope this endpoint needs. |
| 403 | account_restricted | The account can't use the API right now (for example locked, inactive, or onboarding not finished). |
| 403 | api_access_disabled | API access is switched off. |
| 429 | rate_limited | Too many requests. Wait for Retry-After seconds. |
| 429 | too_many_concurrent_requests | Too many requests in flight for this key or account. |
| 429 | key_suspended | The key is suspended, for example after sustained rate limiting. |
| 500 | internal_error | Something went wrong on our side. |
| 502 | bad_gateway | An upstream service answered unexpectedly. |
| 503 | overloaded | The service is overloaded. Retry after Retry-After seconds. |
| 503 | service_unavailable | The service is temporarily unavailable. |
| 504 | gateway_timeout | An upstream service didn't answer in time. A POST may still complete; retry with the same Idempotency-Key. |
Request
# Signed by sign-headers.sh: see Authentication
curl "https://public-api.myntkaup.is/v1/withdrawals?type=bank&limit=10" \
$(./sign-headers.sh GET "/v1/withdrawals?type=bank&limit=10" | sed 's/^/-H /')import { Myntkaup } from "@myntkaup/api";
const client = new Myntkaup(); // reads the key from the environment
const page = await client.withdrawals.list({ type: "bank", limit: 10 });
console.log(page.data.map((withdrawal) => [withdrawal.id, withdrawal.status]));from myntkaup import Myntkaup
client = Myntkaup() # reads the key from the environment
page = client.withdrawals.list(type="bank", limit=10)
print([(withdrawal["id"], withdrawal["status"]) for withdrawal in page["data"]])Response
{
"data": [
{
"id": "wd_01JB8X2Q4M7Z3V9K5T1N6R0P2W",
"type": "crypto",
"status": "completed",
"asset": "BTC",
"network": "bitcoin",
"amount": "0.01",
"fee": "0.0005",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"memo": null,
"bank_account": null,
"tx_id": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
"source": "public_api",
"created_at": "2026-11-03T10:15:10Z",
"confirm_by": null,
"completed_at": "2026-11-03T10:31:44Z"
}
],
"next_cursor": "eyJpZCI6IjY3MjdhMWMzIn0"
}Base URL https://public-api.myntkaup.is