Skip to content
API pro vývojáře

Integrujte a přizpůsobte

Spouštějte Payment for Stripe z vlastní aplikace nebo webu pomocí URL schémat a přímo ve Stripe Dashboardu určujte, které produkty se v aplikaci zobrazí.
Integrace přes URL schémata

Jak to funguje

  1. 1Vaše aplikace otevře payment:// URL s parametry
  2. 2Payment for Stripe se spustí a zpracuje transakci
  3. 3Po dokončení aplikace přesměruje na vaši URL adresu zpětného volání s výsledkem.

Koncové body

Vytvořit platbu

payment://new?Zpracujte jednorázovou platbu s uvedením částky, měny a popisu.

Parametry

  • amountintegerPovinnýČástka v centech (např. 1000 = 10 dolarů)
  • currencystringTřípísmenný kód měny ISO (výchozí: aktuální měna aplikace)
  • descriptionstringPopis platby kódovaný v URL
  • customerstringAlias: customer_idStávající ID zákazníka Stripe
  • emailstringE-mail zákazníka pro účtenku
  • namestringJméno zákazníka kódované pomocí URL
  • metadatastringVlastní páry klíč-hodnota (JSON s kódováním URL)
  • callbackstringURL adresa pro návrat po dokončení
  • autoprocessbooleanAlias: autoPřeskočit domovskou obrazovku a okamžitě zahájit platbu
  • auto_returnbooleanSpustí zpětné volání při načtení výsledku, místo čekání na zavření dialogového okna s výsledky obchodníkem. Výchozí hodnota je false.

Prodávejte položky z vašeho katalogu

payment://cart?Naplňte košík cenami z katalogu Stripe a platbu proveďte osobně. Prodej se uloží jako zaplacená faktura Stripe. Zákazníkovi se nic neodesílá.

Parametry

  • pricesstringPovinnýAlias: line_itemsČárkami oddělená ID cen s množstvím (např. price_abc:2,price_xyz:1)
  • couponstringID kupónu Stripe, který se má použít v košíku
  • customerstringAlias: customer_idStávající ID zákazníka Stripe
  • emailstringE-mail zákazníka pro účtenku
  • namestringJméno zákazníka kódované pomocí URL
  • metadatastringVlastní páry klíč-hodnota (JSON s kódováním URL)
  • callbackstringURL adresa pro návrat po dokončení
  • autoprocessbooleanAlias: autoPřeskočit domovskou obrazovku a okamžitě zahájit platbu
  • auto_returnbooleanSpustí zpětné volání při načtení výsledku, místo čekání na zavření dialogového okna s výsledky obchodníkem. Výchozí hodnota je false.

Zaplatit existující fakturu

payment://invoice?Inkasujte platbu osobně na základě existující faktury Stripe. Částka, měna, zákazník a daň pocházejí z faktury. Přepsání kteréhokoli z těchto údajů je odmítnuto. Obchodník přiloží kartu přes čtečku / Tap to Pay / ruční zadání; v případě úspěchu je faktura označena jako zaplacená mimo pásmo a propojena pomocí metadat charge_id a payment_intent_id. Faktury s předplatným, default_payment_method nebo stavem zaplaceno, neplatné nebo nevymáhatelné jsou odmítnuty s chybou, která vyžaduje akci. Koncepty faktur: iOS je nejprve finalizuje, Android je odmítá s chybou invoice_state_changed.

Parametry

  • idstringPovinnýID faktury Stripe (musí začínat na in_)
  • callbackstringURL adresa pro návrat po dokončení. V případě úspěchu obdrží invoice_id a payment_intent_id.
  • metadatastringVlastní páry klíč-hodnota (JSON s kódováním URL) sloučené do metadat PaymentIntent
  • autoprocessbooleanAlias: autoPřeskočit domovskou obrazovku a okamžitě zahájit platbu
  • auto_returnbooleanSpustí zpětné volání při načtení výsledku, místo čekání na zavření dialogového okna s výsledky obchodníkem. Výchozí hodnota je false.

Zpracování zpětných volání

Po dokončení transakce služba Payment for Stripe přesměruje na vaši URL adresu zpětného volání s parametry dotazu, které udávají výsledek. Ve výchozím nastavení se přesměrování spustí poté, co obchodník zavře dialogové okno s výsledkem, aby mohl provést další akce po platbě (poslat účtenku e-mailem, vrátit peníze). Pro spuštění, jakmile je výsledek znám, zadejte parametr auto_return=true. Podporováno pro iOS a Android.

Parametry zpětného volání

  • statussuccess | error | cancelledVýsledek transakce
  • charge_idstringID platby Stripe (v případě úspěchu). iOS odešle ID platby (ch_). Android odešle ID PaymentIntent (pi_) a vloží ID platby do stripe_charge_id.
  • stripe_charge_idstringID platby Stripe (ch_) v případě úspěchu. Pouze pro Android.
  • invoice_idstringID faktury Stripe (v případě úspěchu, pouze tok payment://invoice)
  • payment_intent_idstringID PaymentIntentu Stripe (v případě úspěchu). iOS: pouze tok payment://invoice. Android: každý prodej kartou.
  • errorstringChybová zpráva (při chybě)
Platba byla zaznamenána, ale fakturu nebylo možné označit jako zaplacenou: iOS vrací status=error s charge_id, invoice_id a payment_intent_id. Android vrací status=success s invoice_reconciliation_failed=true.Starší pole, zachovaná pro starší integrace: success, amount, currency, chargeId, cancelled, error[message]. Nové integrace by měly číst výše uvedená pole.

Příklady

  • Jednoduchá platba

    Naúčtujte 10 dolarů jen se zadáním částkypayment://new?amount=1000
  • Platba s popisem

    Naúčtujte 25 eur s popisempayment://new?amount=2500&currency=eur&description=Coffee%20and%20pastry
  • Účtování u nového zákazníka

    Naúčtujte 50 dolarů a vytvořte záznam zákazníkapayment://new?amount=5000&name=John%20Smith&email=[email protected]
  • Účtovat stávajícímu zákazníkovi

    Naúčtujte 75 dolarů stávajícímu zákazníkovi Stripepayment://new?amount=7500&customer=cus_ABC123xyz
  • Platba s metadaty

    Naúčtujte 100 dolarů s vlastními metadaty pro své záznamypayment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7D
  • Automatické zpracování se zpětným voláním

    Přeskočit domovskou obrazovku a po dokončení se vrátit do aplikacepayment://new?amount=3500&autoprocess=true&callback=myapp://payment-complete
  • Automatický návrat po výsledku

    Spusťte zpětné volání, jakmile je znám výsledek, namísto čekání, až obchodník zavře dialog s výsledkem.payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-complete
  • Košík s položkami

    Účtujte za produkty z vašeho katalogu Stripepayment://cart?prices=price_coffee:2,price_muffin:1&email=[email protected]
  • Zaplatit existující fakturu

    Přijme platbu na místě za existující fakturu Stripe. V případě úspěchu vrátí invoice_id a payment_intent_id.payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paid
  • Kompletní příklad

    Všechny parametry kombinované pro plně integrovaný tokpayment://new?amount=15000&currency=usd&description=Service%20Fee&customer=cus_ABC123xyz&metadata=%7B%22invoice%22%3A%22INV-2024-001%22%7D&autoprocess=true&callback=myapp://payment-result
Kódování URLNezapomeňte v hodnotách parametrů kódovat speciální znaky do URL. Mezery se stanou %20, složené závorky %7B a %7D.
Skrytí produktů pomocí metadat

Skrytí produktů v aplikaci

Aplikace zobrazuje produkty a ceny z vašeho účtu Stripe. Pokud chcete některý z nich v aplikaci skrýt (například položky prodávané pouze ve vašem e-shopu), přidejte produktu nebo ceně ve Stripe Dashboardu tento klíč metadat:payment_hidden = true
  • U produktu: skryje produkt a všechny jeho ceny.
  • U ceny: skryje pouze tuto cenu.
  • Odeberte klíč, nebo jej nastavte na false, aby se položka znovu zobrazila. Změny se projeví při dalším načtení seznamu produktů v aplikaci.
Odkazy na košík fungují dálSkrytí ovlivňuje pouze seznam produktů v aplikaci. Adresy payment://cart odkazující na skrytou cenu fungují dál a stávající předplatná zůstávají beze změny.

Připraveni k integraci?

Stáhněte si aplikaci a začněte testovat svou integraci ještě dnes.