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.

Takmarkaflokkur
withdrawal
Auðkenning
Undirrituð
Idempotency-Key
Skylda

Færibreytur

  • Idempotency-Keystringhausskylda

    1 til 64 stafir úr [A-Za-z0-9_-]. Geymdur í 24 klst.; notaðu hann aftur til að endurtaka beiðni á öruggan hátt.

    Passar við ^[A-Za-z0-9_-]{1,64}$.

Meginmál beiðnar

application/json · CreateCryptoWithdrawalRequest. Óþekktum reitum er hafnað.

  • assetstringskylda

    Tákn rafmyntar, í hástöfum.

    Passar við ^[A-Z0-9]{1,15}$. Dæmi: BTC.

  • networkstringvalfrjálst

    Aðeins þörf fyrir rafmynt á fleiri en einu neti: USDC er á ethereum (sjálfgefið) eða solana.

    Passar við ^[a-z0-9-]{1,40}$. Dæmi: ethereum.

  • amountstring (tugatala)skylda

    Upphæðin sem dregin er af innistæðunni, umsýslugjald meðtalið.

  • addressstringskylda

    1 til 128 stafir. Passar við ^[A-Za-z0-9:._-]+$. Dæmi: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh.

  • memostringvalfrjálst

    Skylda fyrir XRP (destination tag) og HBAR (memo).

    Passar við ^\d{1,20}$.

  • travel_ruleTravelRuleskylda

    Upplýsingar um móttakanda vegna Travel Rule, eins og appið biður um þær.

    5 reitir
    • address_ownerstring (enum)skylda

      Hver á addressuna: þú eða einhver annar.

      Eitt af self, other.

    • wallet_typestring (enum)skylda

      hosted: reikningur hjá kauphöll eða öðrum þjónustuaðila; self_hosted: sjálfhýst veski, þar sem eigandinn geymir lyklana.

      Eitt af hosted, self_hosted.

    • beneficiaryobjectvalfrjálst

      Skylda þegar address_owner er other: full_name fyrir einstakling, company_name og registration_number fyrir fyrirtæki.

      4 reitir
      • typestring (enum)skylda

        Eitt af individual, company.

      • full_namestringvalfrjálst

        1 til 100 stafir. Engin stýritákn.

      • company_namestringvalfrjálst

        1 til 100 stafir. Engin stýritákn.

      • registration_numberstringvalfrjálst

        1 til 100 stafir. Engin stýritákn.

    • vaspstring (enum)valfrjálst

      Skylda þegar wallet_type er hosted: kauphöllin sem heldur utan um addressuna.

      Eitt af binance, coinbase, kraken, crypto_com, bybit, okx, bitget, kucoin, gate_io, htx, mexc, bitfinex, gemini, bitstamp, upbit, bithumb, bitpanda, etoro, revolut, other.

    • vasp_namestringvalfrjálst

      Heiti kauphallarinnar þegar vasp er other.

      1 til 100 stafir. Engin stýritákn.

Svör

202 Accepted

Úttektin, sem bíður staðfestingar í tölvupósti. application/json · Withdrawal

  • idstring

    Byrjar á wd_.

  • typestring (enum)

    Eitt af bank, crypto.

  • 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.

    Eitt af awaiting_confirmation, expired, pending, completed, canceled, failed.

  • assetstring

    Tákn rafmyntar, í hástöfum.

    Passar við ^[A-Z0-9]{1,15}$.

  • networkstring | null

    Aðeins rafmyntaúttektir.

  • amountstring (tugatala)

    Dregið af innistæðunni, umsýslugjald meðtalið.

  • feestring (tugatala)getur verið null

    Umsýslugjald úttektarinnar í rafmyntinni; null meðan það er ekki vitað.

  • addressstring | null

    Aðeins rafmyntaúttektir.

  • memostring | null
  • bank_accountstring | null

    Aðeins bankaúttektir.

  • tx_idstring | null

    Auð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.

    Eitt af public_api, app, web.

  • created_atstring (date-time)
  • confirm_bystring (date-time)getur verið null

    Fyrir 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ðaKóðiMerking
400invalid_requestBeiðnin er gölluð: ógilt JSON, óþekktur eða ógildur reitur, eða haus vantar.
401invalid_signatureMK-* hausana vantar eða þeir eru gallaðir, auðkenni lykilsins er óþekkt eða undirskriftin passar ekki.
401key_expiredGildistími lykilsins er liðinn.
401key_revokedLykillinn var afturkallaður.
401timestamp_out_of_rangeMK-Timestamp munar meira en 30 sekúndum frá klukku netþjónsins.
401nonce_reusedÞessi lykill hefur þegar notað þetta MK-Nonce.
403ip_not_allowedBeiðnin kom frá IP tölu sem er ekki meðal leyfðra IP talna lykilsins.
403insufficient_scopeLykilinn vantar heimildina sem þessi endapunktur þarf.
403account_restrictedAðgangurinn getur ekki notað API-ið eins og er (til dæmis læstur, óvirkur eða nýskráningu ólokið).
403api_access_disabledSlökkt er á aðgangi að API-inu.
403forbiddenSlökkt er á þessari aðgerð í API-inu eins og er.
409idempotency_conflictÞessi Idempotency-Key var notaður með öðru meginmáli.
409idempotency_in_progressBeiðni með þessum Idempotency-Key er enn í vinnslu.
413payload_too_largeMeginmál beiðnarinnar er stærra en 8 KB.
415unsupported_media_typeMeginmál beiðna verður að vera application/json.
422insufficient_fundsLaus innistæða dugar ekki fyrir viðskiptunum, gjafabréfinu eða úttektinni.
422amount_below_minimumUpphæðin er undir lágmarki.
422asset_not_withdrawableEkki er hægt að taka rafmyntina út á þessu neti eins og er.
429rate_limitedOf margar beiðnir. Bíddu í Retry-After sekúndur.
429too_many_concurrent_requestsOf margar beiðnir í vinnslu í einu fyrir þennan lykil eða aðgang.
429key_suspendedLykillinn er stöðvaður, til dæmis eftir að hafa farið ítrekað yfir beiðnatakmörk.
500internal_errorEitthvað fór úrskeiðis hjá okkur.
502bad_gatewayUndirliggjandi þjónusta svaraði á óvæntan hátt.
503overloadedÞjónustan er undir of miklu álagi. Reyndu aftur eftir Retry-After sekúndur.
503service_unavailableÞjónustan er tímabundið ekki tiltæk.
503maintenanceVegna viðhalds er aðeins hægt að lesa úr API-inu.
504gateway_timeoutUndirliggjandi þ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

202 Accepted
{
  "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