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

Spouštějte platby z aplikace nebo webu, předávejte údaje zákazníků a zpracovávejte callbacky.

Skrytí produktů pomocí metadat

Držte produkty prodávané jen online mimo aplikaci jediným klíčem metadat.

Integrace přes URL schémata

Jak to funguje

Vaše aplikace otevře payment:// URL s parametry

Payment for Stripe se spustí a zpracuje transakci

Po 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

Název	Typ	Povinný	Popis
`amount`	integer	Ano	Částka v centech (např. 1000 = 10 dolarů)
`currency`	string	Ne	Třípísmenný kód měny ISO (výchozí: aktuální měna aplikace)
`description`	string	Ne	Popis platby kódovaný v URL
`customer`Alias: `customer_id`	string	Ne	Stávající ID zákazníka Stripe
`email`	string	Ne	E-mail zákazníka pro účtenku
`name`	string	Ne	Jméno zákazníka kódované pomocí URL
`metadata`	string	Ne	Vlastní páry klíč-hodnota (JSON s kódováním URL)
`callback`	string	Ne	URL adresa pro návrat po dokončení
`autoprocess`Alias: `auto`	boolean	Ne	Přeskočit domovskou obrazovku a okamžitě zahájit platbu
`auto_return`	boolean	Ne	Spustí 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

Název	Typ	Povinný	Popis
`prices`Alias: `line_items`	string	Ano	Čárkami oddělená ID cen s množstvím (např. price_abc:2,price_xyz:1)
`coupon`	string	Ne	ID kupónu Stripe, který se má použít v košíku
`customer`Alias: `customer_id`	string	Ne	Stávající ID zákazníka Stripe
`email`	string	Ne	E-mail zákazníka pro účtenku
`name`	string	Ne	Jméno zákazníka kódované pomocí URL
`metadata`	string	Ne	Vlastní páry klíč-hodnota (JSON s kódováním URL)
`callback`	string	Ne	URL adresa pro návrat po dokončení
`autoprocess`Alias: `auto`	boolean	Ne	Přeskočit domovskou obrazovku a okamžitě zahájit platbu
`auto_return`	boolean	Ne	Spustí 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

Název	Typ	Povinný	Popis
`id`	string	Ano	ID faktury Stripe (musí začínat na in_)
`callback`	string	Ne	URL adresa pro návrat po dokončení. V případě úspěchu obdrží invoice_id a payment_intent_id.
`metadata`	string	Ne	Vlastní páry klíč-hodnota (JSON s kódováním URL) sloučené do metadat PaymentIntent
`autoprocess`Alias: `auto`	boolean	Ne	Přeskočit domovskou obrazovku a okamžitě zahájit platbu
`auto_return`	boolean	Ne	Spustí 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í

Parametr	Hodnoty	Popis
`status`	success \| error \| cancelled	Výsledek transakce
`charge_id`	string	ID 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_id`	string	ID platby Stripe (ch_) v případě úspěchu. Pouze pro Android.
`invoice_id`	string	ID faktury Stripe (v případě úspěchu, pouze tok payment://invoice)
`payment_intent_id`	string	ID PaymentIntentu Stripe (v případě úspěchu). iOS: pouze tok payment://invoice. Android: každý prodej kartou.
`error`	string	Chybová 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 částky

payment://new?amount=1000

Platba s popisem

Naúčtujte 25 eur s popisem

payment://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íka

payment://new?amount=5000&name=John%20Smith&[email protected]

Účtovat stávajícímu zákazníkovi

Naúčtujte 75 dolarů stávajícímu zákazníkovi Stripe

payment://new?amount=7500&customer=cus_ABC123xyz

Platba s metadaty

Naúčtujte 100 dolarů s vlastními metadaty pro své záznamy

payment://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 aplikace

payment://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 Stripe

payment://cart?prices=price_coffee:2,price_muffin:1&[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ý tok

payment://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í URL

Nezapomeň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ál

Skrytí 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.

Stáhnout pro iOS Stáhnout pro Android

Kontaktovat podporu