Skip to content

Fejlesztői API

Integráld és szabd testre

Indítsd el a Payment for Stripe alkalmazást a saját alkalmazásodból vagy weboldaladról URL-sémákkal, és a Stripe Dashboard felületéről szabályozd, mely termékek jelenjenek meg az alkalmazásban.

Integráció URL-sémákkal

Hogyan működik

1

Az alkalmazásod megnyit egy payment:// URL-t paraméterekkel

2

A Payment for Stripe elindul, é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ötelezőLeírás
amountintegerIgenÖsszeg centben (pl. 1000 = 10,00 USD)
currencystringNemHárombetűs ISO pénznemkód (alapértelmezett: az alkalmazás aktuális pénzneme)
descriptionstringNemURL-kódolású terhelési leírás
customerÁlnév: customer_idstringNemMeglé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
autoprocessÁlnév: autobooleanNemKihagyja a kezdőképernyőt, és azonnal elindítja a terhelést
auto_returnbooleanNemVisszahívást indít, amint az eredmény betöltődik, ahelyett, hogy megvárná, amíg a kereskedő bezárja az eredményablakot. Alapértelmezett: false.

Eladja a katalógusából származó tételeket

payment://cart?

Töltsd meg a kosarat Stripe katalógusod áraival személyes átvétel esetén. Az eladás kifizetett Stripe számlaként kerül mentésre. A vásárlónak nem küldünk semmit.

Paraméterek

NévTípusKötelezőLeírás
pricesÁlnév: line_itemsstringIgenVesszővel elválasztott árazonosítók mennyiségekkel (pl. price_abc:2,price_xyz:1)
couponstringNemA kosárhoz alkalmazható Stripe kuponazonosító
customerÁlnév: customer_idstringNemMeglé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
autoprocessÁlnév: autobooleanNemKihagyja a kezdőképernyőt, és azonnal elindítja a terhelést
auto_returnbooleanNemVisszahívást indít, amint az eredmény betöltődik, ahelyett, hogy megvárná, amíg a kereskedő bezárja az eredményablakot. Alapértelmezett: false.

Meglévő számla fizetése

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 bármelyikének felülbírálása elutasításra kerül. A kereskedő kártyaolvasón / Tap to Pay / manuális bevitelen keresztül lekérdezi a kártyát; sikeres fizetés esetén a számla sávon kívüli kifizetettként lesz megjelölve, és charge_id és payment_intent_id metaadatokon keresztül kapcsolódik hozzá. Az előfizetéssel, default_payment_method státusszal, fizetve, érvénytelenítve vagy behajthatatlanul megjelölt számlákat a rendszer elutasítja egy műveletet igénylő hibával. Vázlatszámlák: Az iOS először véglegesíti őket, az Android invoice_state_changed hibakóddal elutasítja őket.

Paraméterek

NévTípusKötelezőLeírás
idstringIgenStripe-számlaazonosító (in_ előtaggal 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
autoprocessÁlnév: autobooleanNemKihagyja a kezdőképernyőt, és azonnal elindítja a terhelést
auto_returnbooleanNemVisszahívást indít, amint az eredmény betöltődik, ahelyett, hogy megvárná, amíg a kereskedő bezárja az eredményablakot. Alapértelmezett: false.

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 történik, hogy a kereskedő bezárja az eredményablakot, így még elvégezheti a terhelés utáni műveleteket (nyugta küldése e-mailben, visszatérítés). Add meg az auto_return=true paramétert, ha azt szeretnéd, hogy az átirányítás azonnal megtörténjen, amint ismert az eredmény. 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). Az iOS elküldi a terhelési azonosítót (ch_). Az Android elküldi a PaymentIntent azonosítót (pi_), és a terhelési azonosítót a stripe_charge_id-ba helyezi.
stripe_charge_idstringStripe terhelési azonosító (ch_) sikeres tranzakció esetén. Csak Androidon.
invoice_idstringStripe számlaazonosító (siker esetén, csak payment://invoice folyamat esetén)
payment_intent_idstringStripe PaymentIntent ID (siker esetén). iOS: csak payment://invoice folyamat. Android: minden kártyás vásárlás.
errorstringHibaüzenet (hiba esetén)

A terhelés rögzítve, de a számlát nem sikerült kifizetettként megjelölni: az iOS status=error értéket ad vissza, charge_id, invoice_id és payment_intent_id értékekkel. Az Android status=success értéket ad vissza, invoice_reconciliation_failed=true értékkel.

Régi mezők, régebbi integrációkhoz megtartva: success, amount, currency, chargeId, cancelled, error[message]. Az új integrációknak a fenti mezőket kell olvasniuk.

Példák

Egyszerű terhelés

10,00 dollár terhelése csak az összeg megadásával

payment://new?amount=1000

Terhelés leírással

25,00 € terhelése leírással

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

Terhelés új ügyféllel

50,00 dollár terhelése és ügyfélrekord létrehozása

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

Meglévő ügyfél megterhelése

Meglévő Stripe-ügyfél megterhelése 75,00 dollárral

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

Terhelés metaadatokkal

100,00 dollár terhelése egyéni metaadatokkal a nyilvántartásodhoz

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

Hagyd ki a kezdőképernyőt, és a végén térj vissza az alkalmazásodba

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

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

Visszahívás indítása, amint ismert az eredmény, ahelyett, hogy meg kellene várni, amíg a kereskedő bezárja az eredményablakot

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

Kosár sorokkal

Díj felszámítása Stripe katalógusodban szereplő termékekért

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

Meglévő számla befizetése

Helyszíni fizetés beszedése egy meglévő Stripe-számlára. Siker esetén visszaadja az invoice_id és a payment_intent_id értékét.

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

Teljes példa

Minden paraméter kombinálva a teljesen integrált folyamathoz

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özből %20, a kapcsos zárójelekből %7B és %7D lesz.

Termékek elrejtése metaadatokkal

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 ki szeretnél zárni az alkalmazásból (például a csak az online áruházadban értékesített tételeket), add hozzá ezt a metaadatkulcsot a termékhez vagy az árhoz a Stripe Dashboard felületén:

payment_hidden = true

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

Egy áron: csak azt az árat rejti el.

Távolítsd el a kulcsot, vagy állítsd false értékre, hogy újra megjelenjen. A módosítá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 állsz az integrációra?

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