Skip to content

Fejlesztői API

Integráljon és testreszabás

Indítsd el a Stripe fizetését saját alkalmazásodból vagy webhelyedről URL-sémák segítségével, és közvetlenül a Stripe irányítópultjáról szabályozd, hogy mely termékek jelenjenek meg az alkalmazásban.

Integráció URL-sémákkal

Hogyan működik

1

Az alkalmazás megnyílik egy fizetés:// URL paraméterekkel

2

A Stripe fizetése elindítja és feldolgozza a tranzakciót

3

Befejezés után az alkalmazás átirányít a visszahívási URL-címedre az eredménnyel.

Végpontok

Terhelés létrehozása

payment://new?

Egyszeri fizetés feldolgozása összeggel, pénznemmel és leírással.

Paraméterek

NévTípusKívántLeírás
amountintegerIgenÖsszeg centben (pl. 1000 = 10,00 USD)
currencystringNemHárombetűs ISO pénznemkód (alapértelmezett: USD)
descriptionstringNemURL-kódolású terhelési leírás
customerstringNemMeglévő Stripe ügyfél-azonosító
emailstringNemÜgyfél e-mail címe a nyugtához
namestringNemURL-kódolású ügyfélnév
metadatastringNemEgyéni kulcs-érték párok (URL-kódolású JSON)
callbackstringNemURL, ahová a befejezés után vissza kell térni
autoprocessbooleanNemKihagyja a kezdőképernyőt, és azonnal megkezdi a töltést
auto_returnbooleanNemVisszahívást indít, amikor az eredmény betöltődik, ahelyett, hogy megvárná, amíg a kereskedő bezárja az eredmény párbeszédpanelt. Alapértelmezés szerint hamis.

Számla létrehozása

payment://cart?

Hozz létre egy Stripe számlát a termékkatalógusodból származó tételekkel.

Paraméterek

NévTípusKívántLeírás
pricesstringIgenVesszővel elválasztott árazonosítók mennyiségekkel (pl. price_abc:2,price_xyz:1)
customerstringNemMeglévő Stripe ügyfél-azonosító
emailstringNemÜgyfél e-mail címe a nyugtához
namestringNemURL-kódolású ügyfélnév
callbackstringNemURL, ahová a befejezés után vissza kell térni
auto_returnbooleanNemVisszahívást indít, amikor az eredmény betöltődik, ahelyett, hogy megvárná, amíg a kereskedő bezárja az eredmény párbeszédpanelt. Alapértelmezés szerint hamis.

Meglévő számla befizetése (csak iOS rendszeren)

payment://invoice?

Személyes fizetés beszedése egy meglévő Stripe számláról. Az összeg, a pénznem, az ügyfél és az adó a számlából származik. Ezek felülbírálása elutasításra kerül. A kereskedő leolvasón / Tap to Pay-en / manuális bevitelen keresztül lekérdezi a kártyát; sikeres fizetés esetén a számla sávon kívüliként lesz megjelölve, és a charge_id és a payment_intent_id metaadatokon keresztül összekapcsolódik. Az előfizetéssel, alapértelmezett fizetési móddal vagy nem nyitott állapottal rendelkező számlákat a rendszer elhárítja egy műveletet igénylő hibával.

Paraméterek

NévTípusKívántLeírás
idstringIgenStripe számlaazonosító (in_ karakterrel kell kezdődnie)
callbackstringNemURL, ahová a befejezés után vissza kell térni. Siker esetén megkapja az invoice_id és a payment_intent_id értékeket.
metadatastringNemEgyéni kulcs-érték párok (URL-kódolású JSON) egyesítve a PaymentIntent metaadatokkal
autoprocessbooleanNemKihagyja a kezdőképernyőt, és azonnal megkezdi a töltést
auto_returnbooleanNemVisszahívást indít, amikor az eredmény betöltődik, ahelyett, hogy megvárná, amíg a kereskedő bezárja az eredmény párbeszédpanelt. Alapértelmezés szerint hamis.

Visszahívások kezelése

Amikor a tranzakció befejeződik, a Payment for Stripe átirányít a visszahívási URL-címedre, amelynek lekérdezési paraméterei jelzik az eredményt. Alapértelmezés szerint az átirányítás azután aktiválódik, hogy a kereskedő bezárja az eredmény párbeszédpanelt, így utólagos műveleteket végezhet (nyugta küldése e-mailben, visszatérítés). Adj meg egy auto_return=true paramétert, hogy az átirányítás az eredmény ismertsége után azonnal aktiválódjon. iOS és Android rendszeren támogatott.

Visszahívási paraméterek

ParaméterÉrtékekLeírás
statussuccess | error | cancelledA tranzakció eredménye
charge_idstringStripe terhelési azonosító (siker esetén)
invoice_idstringStripe számlaazonosító (siker esetén, csak payment://invoice folyamat esetén)
payment_intent_idstringStripe PaymentIntent ID (siker esetén, csak payment://invoice folyamat esetén)
errorstringHibaüzenet (hiba esetén)

Példák

Egyszerű töltés

Töltsön 10 dollárt csupán egy összeggel

payment://new?amount=1000

Díj leírással

25,00 € felár leírással

payment://new?amount=2500&currency=eur&description=Coffee%20and%20pastry

Új ügyféllel történő fizetés

50,00 dollár felszámítása és ügyfélrekord létrehozása

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

Meglévő ügyfél számlázása

75,00 dollár felszámítása egy meglévő Stripe ügyfélnek

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

Metaadatokkal történő töltés

Számoljon 100 dollárral egyéni metaadatokkal a rekordjaihoz

payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7D

Automatikus feldolgozás visszahívással

Ha kész, ugorj át a kezdőképernyőn, és térj vissza az alkalmazásodhoz

payment://new?amount=3500&autoprocess=true&callback=myapp://payment-complete

Automatikus visszatérés az eredmény megjelenésekor

Amint az eredmény ismert, indítsa el a visszahívást, ahelyett, hogy megvárná, amíg a kereskedő bezárja az eredmény párbeszédpanelt.

payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-complete

Számla sorokkal

Hozzon létre számlát a Stripe katalógusában szereplő termékekkel

payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]

Meglévő számla befizetése (iOS)

Személyes fizetés beszedése egy meglévő Stripe számlára. Sikeres fizetés esetén visszaadja az invoice_id és a payment_intent_id értékeket.

payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paid

Teljes példa

Minden paraméter kombinálva a teljesen integrált áramlás érdekében

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

URL-kódolás

Ne felejtsd el URL-kódolni a paraméterértékekben található speciális karaktereket. A szóközök %20-ba, a kapcsos zárójelek %7B-be és %7D-be kerülnek.

Metaadatokkal rendelkező termékek elrejtése

Termékek elrejtése az alkalmazásból

Az alkalmazás listázza a Stripe-fiókodban szereplő termékeket és árakat. Ha egy terméket (például csak az online áruházadon keresztül értékesített termékeket) ki szeretnél zárni az alkalmazásból, add hozzá ezt a metaadatkulcsot a termékhez vagy árhoz a Stripe irányítópulton:

payment_hidden = true

Egy terméken: elrejti a terméket és az összes árát.

Ár alapján: csak az adott árat rejti el.

Távolítsa el a kulcsot, vagy állítsa hamis értékre, hogy újra megjelenjen. A változások akkor lépnek életbe, amikor az alkalmazás legközelebb betölti a terméklistát.

A kosár linkjei továbbra is működnek

Az elrejtés csak az alkalmazáson belüli terméklistát érinti. A rejtett árra hivatkozó payment://cart URL-ek továbbra is működnek, és a meglévő előfizetéseket ez nem érinti.

Készen áll az integrációra?

Töltsd le az alkalmazást, és kezdd el tesztelni az integrációdat még ma!