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 v panelu Stripe určujte, které produkty se v aplikaci zobrazí.
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
| Jméno | Typ | Požadovaný | Popis |
|---|---|---|---|
amount | integer | Ano | Částka v centech (např. 1000 = 10,00 USD) |
currency | string | Ne | Třípísmenný kód měny ISO (výchozí: USD) |
description | string | Ne | Popis platby kódovaný v URL |
customer | string | Ne | Stávající ID zákazníka Stripe |
email | string | Ne | E-mail zákazníka pro potvrzení |
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 | 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. |
Vytvořit fakturu
payment://cart?Vytvořte fakturu Stripe s položkami z katalogu produktů.
Parametry
| Jméno | Typ | Požadovaný | Popis |
|---|---|---|---|
prices | string | Ano | Čárkami oddělená ID cen s množstvím (např. price_abc:2,price_xyz:1) |
customer | string | Ne | Stávající ID zákazníka Stripe |
email | string | Ne | E-mail zákazníka pro potvrzení |
name | string | Ne | Jméno zákazníka kódované pomocí URL |
callback | string | Ne | URL adresa pro návrat po dokončení |
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. |
Zaplacení existující faktury (pouze pro iOS)
payment://invoice?Přijměte platbu na místě k existující faktuře 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řijme kartu přes čtečku / Tap to Pay / ruční zadání; v případě úspěchu je faktura označena jako zaplacená mimo Stripe a propojena pomocí metadat charge_id a payment_intent_id. Faktury s předplatným, default_payment_method nebo jiným stavem než otevřená jsou odmítnuty s chybou, která uvádí, co udělat.
Parametry
| Jméno | Typ | Požadovaný | 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 | 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ě (odeslat potvrzení 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) |
invoice_id | string | ID faktury Stripe (v případě úspěchu, pouze tok payment://invoice) |
payment_intent_id | string | ID PaymentIntent Stripe (v případě úspěchu, pouze tok payment://invoice) |
error | string | Chybová zpráva (při chybě) |
Příklady
Jednoduchá platba
Účtujte 10,00 USD pouze určitou částkou
payment://new?amount=1000Platba s popisem
Účtujte 25,00 € s popisem
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryÚčtování u nového zákazníka
Účtujte 50,00 USD 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
Účtovat 75,00 USD stávajícímu zákazníkovi Stripe
payment://new?amount=7500&customer=cus_ABC123xyzPlatba s metadaty
Účtujte 100,00 USD 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%7DAutomatické 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-completeAutomatický 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-completeFaktura s položkami
Vytvořte fakturu s produkty z vašeho katalogu Stripe
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Zaplatit existující fakturu (iOS)
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-paidKompletní příklad
Všechny parametry kombinované pro plně integrovaný tok
payment://new?amount=15000¤cy=usd&description=Service%20Fee&customer=cus_ABC123xyz&metadata=%7B%22invoice%22%3A%22INV-2024-001%22%7D&autoprocess=true&callback=myapp://payment-resultKó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.
Připraveni k integraci?
Stáhněte si aplikaci a začněte testovat svou integraci ještě dnes.