API lýsing · Úttektir
Taka út rafmynt
POST/v1/withdrawals/crypto
Biður um úttekt á rafmyntaaddressu og sendir staðfestingarhlekk á netfang aðgangsins. Ekkert er sent, eða tekið frá, fyrr en hlekkurinn er opnaður, innan 30 mínútna. Idempotency-Key er skylda.
- Heimild
withdrawals:create- Takmarkaflokkur
withdrawal- Auðkenning
- Undirrituð
- Idempotency-Key
- Skylda
Færibreytur
Idempotency-Keystringhausskylda1 til 64 stafir úr
[A-Za-z0-9_-]. Geymdur í 24 klst.; notaðu hann aftur til að endurtaka beiðni á öruggan hátt.
Meginmál beiðnar
application/json · CreateCryptoWithdrawalRequest. Óþekktum reitum er hafnað.
assetstringskyldaTákn rafmyntar, í hástöfum.
networkstringvalfrjálstAðeins þörf fyrir rafmynt á fleiri en einu neti: USDC er á
ethereum(sjálfgefið) eðasolana.amountstring (tugatala)skyldaUpphæðin sem dregin er af innistæðunni, umsýslugjald meðtalið.
addressstringskyldamemostringvalfrjálstSkylda fyrir XRP (destination tag) og HBAR (memo).
travel_ruleTravelRuleskyldaUpplýsingar um móttakanda vegna Travel Rule, eins og appið biður um þær.
5 reitir
address_ownerstring (enum)skyldaHver á addressuna: þú eða einhver annar.
wallet_typestring (enum)skyldahosted: reikningur hjá kauphöll eða öðrum þjónustuaðila;self_hosted: sjálfhýst veski, þar sem eigandinn geymir lyklana.beneficiaryobjectvalfrjálstSkylda þegar
address_ownererother:full_namefyrir einstakling,company_nameogregistration_numberfyrir fyrirtæki.4 reitir
typestring (enum)skyldafull_namestringvalfrjálstcompany_namestringvalfrjálstregistration_numberstringvalfrjálst
vaspstring (enum)valfrjálstSkylda þegar
wallet_typeerhosted: kauphöllin sem heldur utan um addressuna.vasp_namestringvalfrjálstHeiti kauphallarinnar þegar
vasperother.
Svör
202 Accepted
Úttektin, sem bíður staðfestingar í tölvupósti. application/json · Withdrawal
idstringtypestring (enum)statusstring (enum)awaiting_confirmation: rafmyntaúttekt sem bíður eftir að hlekkurinn í staðfestingarpóstinum sé opnaður;expired: hlekkurinn var ekki notaður í tæka tíð;pending: í vinnslu;completed: send;canceled: hætt við;failed: mistókst.assetstringTákn rafmyntar, í hástöfum.
networkstring | nullAðeins rafmyntaúttektir.
amountstring (tugatala)Dregið af innistæðunni, umsýslugjald meðtalið.
feestring (tugatala)getur verið nullUmsýslugjald úttektarinnar í rafmyntinni;
nullmeðan það er ekki vitað.addressstring | nullAðeins rafmyntaúttektir.
memostring | nullbank_accountstring | nullAðeins bankaúttektir.
tx_idstring | nullAuðkenni færslunnar á bálkakeðjunni, þegar hún hefur verið send.
sourcestring (enum)Hvar færslan varð til: í þessu API, í appinu eða í vefappinu.
created_atstring (date-time)confirm_bystring (date-time)getur verið nullFyrir
awaiting_confirmation: hlekkurinn í staðfestingarpóstinum virkar til þessa tíma.completed_atstring (date-time)getur verið null
Öll svör bera MK-Request-Id, auk RateLimit-Policy og RateLimit.
Villur
Villur nota villuumslagið. Greindu þær eftir code.
| Staða | Kóði | Merking |
|---|---|---|
| 400 | invalid_request | Beiðnin er gölluð: ógilt JSON, óþekktur eða ógildur reitur, eða haus vantar. |
| 401 | invalid_signature | MK-* hausana vantar eða þeir eru gallaðir, auðkenni lykilsins er óþekkt eða undirskriftin passar ekki. |
| 401 | key_expired | Gildistími lykilsins er liðinn. |
| 401 | key_revoked | Lykillinn var afturkallaður. |
| 401 | timestamp_out_of_range | MK-Timestamp munar meira en 30 sekúndum frá klukku netþjónsins. |
| 401 | nonce_reused | Þessi lykill hefur þegar notað þetta MK-Nonce. |
| 403 | ip_not_allowed | Beiðnin kom frá IP tölu sem er ekki meðal leyfðra IP talna lykilsins. |
| 403 | insufficient_scope | Lykilinn vantar heimildina sem þessi endapunktur þarf. |
| 403 | account_restricted | Aðgangurinn getur ekki notað API-ið eins og er (til dæmis læstur, óvirkur eða nýskráningu ólokið). |
| 403 | api_access_disabled | Slökkt er á aðgangi að API-inu. |
| 403 | forbidden | Slökkt er á þessari aðgerð í API-inu eins og er. |
| 409 | idempotency_conflict | Þessi Idempotency-Key var notaður með öðru meginmáli. |
| 409 | idempotency_in_progress | Beiðni með þessum Idempotency-Key er enn í vinnslu. |
| 413 | payload_too_large | Meginmál beiðnarinnar er stærra en 8 KB. |
| 415 | unsupported_media_type | Meginmál beiðna verður að vera application/json. |
| 422 | insufficient_funds | Laus innistæða dugar ekki fyrir viðskiptunum, gjafabréfinu eða úttektinni. |
| 422 | amount_below_minimum | Upphæðin er undir lágmarki. |
| 422 | asset_not_withdrawable | Ekki er hægt að taka rafmyntina út á þessu neti eins og er. |
| 429 | rate_limited | Of margar beiðnir. Bíddu í Retry-After sekúndur. |
| 429 | too_many_concurrent_requests | Of margar beiðnir í vinnslu í einu fyrir þennan lykil eða aðgang. |
| 429 | key_suspended | Lykillinn er stöðvaður, til dæmis eftir að hafa farið ítrekað yfir beiðnatakmörk. |
| 500 | internal_error | Eitthvað fór úrskeiðis hjá okkur. |
| 502 | bad_gateway | Undirliggjandi þjónusta svaraði á óvæntan hátt. |
| 503 | overloaded | Þjónustan er undir of miklu álagi. Reyndu aftur eftir Retry-After sekúndur. |
| 503 | service_unavailable | Þjónustan er tímabundið ekki tiltæk. |
| 503 | maintenance | Vegna viðhalds er aðeins hægt að lesa úr API-inu. |
| 504 | gateway_timeout | Undirliggjandi þjónusta svaraði ekki í tæka tíð. POST beiðni gæti samt klárast; reyndu aftur með sama Idempotency-Key. |
Beiðni
# Signed by sign-headers.sh: see Authentication
body='{"asset":"BTC","amount":"0.01","address":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","travel_rule":{"address_owner":"self","wallet_type":"self_hosted"}}'
idempotency_key=$(uuidgen) # reuse it to retry safely
curl https://public-api.myntkaup.is/v1/withdrawals/crypto \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $idempotency_key" \
$(./sign-headers.sh POST /v1/withdrawals/crypto "$body" | sed 's/^/-H /') \
--data "$body"import { Myntkaup } from "@myntkaup/api";
const client = new Myntkaup(); // reads the key from the environment
// Nothing is sent until the link in the confirmation email is opened.
const withdrawal = await client.withdrawals.createCrypto({
asset: "BTC",
amount: "0.01",
address: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
travelRule: { addressOwner: "self", walletType: "self_hosted" },
});
console.log(withdrawal.status, withdrawal.confirm_by);from myntkaup import Myntkaup
client = Myntkaup() # reads the key from the environment
# Nothing is sent until the link in the confirmation email is opened.
withdrawal = client.withdrawals.create_crypto(
asset="BTC",
amount="0.01",
address="bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
travel_rule={"address_owner": "self", "wallet_type": "self_hosted"},
)
print(withdrawal["status"], withdrawal["confirm_by"])Svar
{
"id": "wd_01JB8X2Q4M7Z3V9K5T1N6R0P2W",
"type": "crypto",
"status": "awaiting_confirmation",
"asset": "BTC",
"network": "bitcoin",
"amount": "0.01",
"fee": "0.0005",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"memo": null,
"bank_account": null,
"tx_id": null,
"source": "public_api",
"created_at": "2026-11-03T10:15:10Z",
"confirm_by": "2026-11-03T10:45:10Z",
"completed_at": null
}Grunnslóð https://public-api.myntkaup.is