Průvodci

API kryptoplatební brány: faktury, webhooky, výplaty a white label

API kryptoplatební brány umožňuje vaší platformě vytvářet faktury, přijímat podepsané webhooky o zachycení a potvrzení platby na blockchainu a odesílat vratky nebo výplaty. Vytvoříte fakturu s fiat částkou, zobrazíte vrácenou adresu nebo hostovanou stránku a objednávku považujete za zaplacenou až po konečném stavu od brány. Podplacení, expirace a idempotentní opakování je třeba ošetřit výslovně.

Autor OrsunPay editorial teamPublikováno

Co dělá API kryptoplatební brány?

API skrývá blockchain před vaším kódem. Místo provozu nodů, odvozování adres a počítání potvrzení zavoláte endpoint pro vytvoření faktury, uložíte si identifikátor brány a čekáte na notifikace. Brána vyčíslí směnný kurz, sleduje sítě, provádí AML kontrolu a vypořádává na váš zůstatek.

Většina bran nabízí stejné stavební kameny pod různými názvy: faktury nebo objednávky pro příchozí platby, IPN nebo callbacky pro notifikace, endpointy pro konverzi a zůstatky a výplaty či výběry pro odchozí převody. Sandbox mají u většiny poskytovatelů, například samostatný sandbox host u CoinGate a sandbox účet u NOWPayments, a je vhodné ho použít před jakýmkoli testem na mainnetu.

  • Invoice API: vytvoření, čtení a zrušení platebních požadavků s fiat cenou, přijímanými coiny, referencí objednávky a callback URL
  • Notifikace: webhooky nebo IPN při každé změně stavu, obvykle podepsané
  • Payouts API: odeslání kryptoměny nebo fiat zákazníkům, partnerům či do vlastní peněženky
  • Kurzy a měny: seznam podporovaných coinů, sítí, minimálních částek a aktuálních kotací
  • Pluginy a SDK: hotové moduly pro e-commerce platformy nad stejným API

Jak funguje životní cyklus faktury?

Každá brána má vlastní model stavů, proto je před psaním obchodní logiky namapujte na malou sadu interních stavů. Zboží smí uvolnit jen konečný stav zaplaceno; mezistavy existují proto, že transakci lze na blockchainu vidět dlouho předtím, než je bezpečné ji přijmout.

Tabulka mapuje dva zveřejněné modely stavů na stavy, které potřebuje většina platforem. CoinGate například nezaplacenou fakturu nechá vypršet po 20 minutách od chvíle, kdy zákazník zvolil coin, a platby zachycené AML kontrolou vede jako neplatné.

Stavy bran namapované na interní stavy
Interní stavCoinGate API v2NOWPaymentsAkce ve vašem systému
VytvořenonewwaitingZobrazit platební stránku, spustit časovač
Zachycenopending, confirmingconfirming, confirmed, sendingZobrazit obrazovku čekání, neexpedovat
ZaplacenopaidfinishedVyřídit objednávku, zaznamenat vypořádání
ČástečněVe zveřejněném seznamu bez samostatného stavupartially_paidVyžádat rozdíl nebo vrátit
Selhaloinvalid, expired, canceledfailed, expiredUvolnit zásoby, povolit nový pokus
Vrácenorefunded, partially_refundedrefundedAktualizovat objednávku a účetnictví

Jak ověřovat krypto webhooky a IPN?

Každou notifikaci považujte za nedůvěryhodnou, dokud ji neověříte. Brány používají různá schémata: NOWPayments podepisuje seřazené JSON tělo pomocí HMAC-SHA512 a posílá podpis v hlavičce x-nowpayments-sig, CoinGate posílá token, který nastavíte na objednávce, a BitPay doporučuje po každé notifikaci načíst fakturu z API místo důvěry v její tělo.

Nejbezpečnější vzor kombinuje obojí: ověřte podpis, poté načtěte fakturu z API a jednejte podle této odpovědi. Stojí to jeden požadavek na změnu stavu a chrání vás to před falešnými nebo přehranými callbacky.

  • Podpisy ověřujte porovnáním v konstantním čase a nepodepsané požadavky odmítejte
  • Před změnou stavu objednávky znovu načtěte fakturu podle jejího ID u brány
  • Rychle vracejte HTTP 200 a zpracovávejte asynchronně; brány při chybě opakují
  • Každou notifikaci ukládejte s událostí či stavem, aby se duplicity ignorovaly
  • Nikdy nevěřte částkám a měnám odeslaným v přesměrování z prohlížeče

Jak řešit podplacení, přeplacení a pozdní platby?

Peněženky a burzy strhávají poplatky za výběr a zákazníci částky opisují nepřesně, takže na přesnou platbu se nelze spoléhat. Před spuštěním definujte toleranci a pravidlo pro každý případ a výsledek zpřístupněte pracovníkům podpory.

Běžné okrajové případy a typické řešení
PřípadCo se stane na blockchainuTypické řešení
PodplaceníDorazí méně než vyčíslená částkaPřijmout v malé toleranci, vyžádat doplatek, nebo vrátit
PřeplaceníDorazí více než vyčíslená částkaOznačit jako zaplaceno, přebytek připsat nebo na žádost vrátit
Pozdní platbaProstředky dorazí po vypršení zamčeného kurzuZnovu vyčíslit aktuálním kurzem, nebo vrátit
Špatná síťToken odeslán v nepodporovaném řetězciRuční obnova, pokud je možná, často za poplatek
AML pozdrženíZdrojová peněženka označena kontrolouPlatba pozdržena nebo označena jako neplatná, kontrola compliance

Jak fungují idempotence a párování plateb?

Faktury vytvářejte s vlastní referencí objednávky a volání proveďte tak, aby šlo bezpečně opakovat: pokud požadavek vyprší, před vytvořením další faktury ji vyhledejte podle reference, nebo použijte idempotentní klíč tam, kde ho brána podporuje. Stejné pravidlo platí pro výplaty, kde duplicitní požadavek pošle skutečné peníze dvakrát.

Pro párování ukládejte ID faktury u brány, hash transakce, fiat částku, krypto částku, kurz a poplatek. Reporty vypořádání uvádějí výplaty po dávkách, takže párování probíhá od objednávky přes fakturu k výplatě, nikoli od objednávky k řádku na bankovním výpisu.

Co potřebuje Payouts API kvůli Travel Rule?

Výplatní endpointy posílají krypto ze zůstatku u brány na adresu, často po dávkách pro provize partnerů, prodejce na tržišti nebo výběry zákazníků. Většina vyžaduje whitelist adres, dvoufázové schválení nebo API klíč se samostatným oprávněním pro výplaty.

V EU nařízení (EU) 2023/1113 ukládá bráně předávat s každým převodem údaje o odesílateli a příjemci a nad 1 000 EUR ověřovat vlastnictví vlastních (self-hosted) peněženek. Počítejte s tím, že požadavky na výplatu budou obsahovat jméno příjemce a typ adresy, a naplánujte převody, které na tyto údaje čekají.

Jaké jsou možnosti white label kryptoplatební brány?

Platformy, které platby přeprodávají vlastním obchodníkům, často chtějí platební stránku pod vlastní značkou. Existují tři úrovně a cena roste s mírou kontroly. Plisio například uvádí 0,5 % za API a 1,5 % za white label a NOWPayments prodává samostatný white-label produkt.

Plný white label přesouvá nejen branding, ale i odpovědnost. Pokud sami onboardujete obchodníky a držíte jejich zůstatky, můžete potřebovat vlastní povolení podle MiCA; model sub-merchantů u autorizované brány drží tuto povinnost u brány.

Modely white label
ModelBrandingKdo onboarduje obchodníkyRegulatorní zátěž na vás
Hostovaná faktura s logemStránka brány, vaše logoBránaNízká
Vlastní UI nad API brányZcela vašeBrána, za každý obchodnický účetNízká až střední
White-label platformaZcela vaše, vlastní administraceVyVysoká, může vyžadovat povolení CASP

Jak napojit API kryptobran přes OrsunPay?

OrsunPay sjednocuje stavy kryptobran, webhooky a vratky do jednoho API vedle vašich karetních a bankovních poskytovatelů, a to na vašich vlastních účtech u bran. Krypto nedrží ani nevyplácí z vlastního zůstatku; směruje požadavky na bránu, kterou zvolíte, a vrací podepsané, deduplikované události.

Jak integrovat API platební brány pro kryptoměny

  1. Založte sandbox účty Vytvořte u brány sandbox i produkční účet, vygenerujte samostatné API klíče pro faktury a výplaty a nastavte tajný klíč IPN.
  2. Namapujte stavy Přeložte stavy brány na své interní stavy a rozhodněte, který z nich uvolňuje zboží.
  3. Vytvářejte faktury idempotentně Odešlete fiat částku, měnu, referenci objednávky a callback URL; před opakováním volání, které vypršelo, vyhledejte fakturu podle reference.
  4. Ověřujte notifikace Zkontrolujte podpis, znovu načtěte fakturu z API a událost zpracujte jen jednou.
  5. Ošetřete okrajové případy Implementujte toleranci, doplatek, vratku a expiraci a každý scénář otestujte v sandboxu.
  6. Párujte vypořádání U každé faktury ukládejte hash transakce, kurz a poplatek a denně párujte dávky výplat s objednávkami.

Často kladené otázky

Co je API platební brány pro kryptoměny?

Je to sada HTTP endpointů a webhooků, díky nimž váš software vytváří krypto faktury, přijímá aktualizace stavů plateb a odesílá vratky či výplaty. Adresy, sledování blockchainu, konverzi a compliance zajišťuje brána.

Co je white-label kryptoplatební brána?

Je to produkt brány, který prezentujete pod vlastní značkou, od loga na hostované stránce po plnou platformu s vlastní administrací. Čím hlubší white label, tím víc odpovědnosti za onboarding a regulaci přebíráte.

Kolik potvrzení mám čekat?

Nechte rozhodnout bránu a jednejte podle jejího konečného stavu zaplaceno. Brány nastavují prahy potvrzení podle sítě a částky a vyvažují rychlost proti riziku reorganizace bloku.

Jak ověřit webhook krypto platby?

Zkontrolujte podpis nebo token, který brána poskytuje, poté načtěte fakturu z API a jednejte podle této odpovědi. Každou událost zpracujte jednou a rychle vraťte HTTP 200.

Mohu si postavit vlastní kryptoplatební bránu?

Nody a odvozování adres si provozovat můžete, ale převádět, držet či přeposílat krypto pro další osoby vás podle MiCA činí poskytovatelem služeb souvisejících s kryptoaktivy. Většina platforem proto používá API autorizované brány.

Nabízejí kryptobrány sandbox?

Většina ano. CoinGate a NOWPayments například poskytují sandboxy s testovacími přihlašovacími údaji, takže celý průběh faktury a callbacku můžete projít bez skutečných prostředků.

Objevte OrsunPay

Promluvte si s naším týmem

Zdroje