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
Az alkalmazásod megnyit egy payment:// URL-t paraméterekkel
A Payment for Stripe elindul, és feldolgozza a tranzakciót
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év | Típus | Kötelező | Leírás |
|---|---|---|---|
amount | integer | Igen | Összeg centben (pl. 1000 = 10,00 USD) |
currency | string | Nem | Hárombetűs ISO pénznemkód (alapértelmezett: az alkalmazás aktuális pénzneme) |
description | string | Nem | URL-kódolású terhelési leírás |
customerÁlnév: customer_id | string | Nem | Meglévő Stripe ügyfél-azonosító |
email | string | Nem | Ügyfél e-mail-címe a nyugtához |
name | string | Nem | URL-kódolású ügyfélnév |
metadata | string | Nem | Egyéni kulcs-érték párok (URL-kódolású JSON) |
callback | string | Nem | URL, ahová a befejezés után vissza kell térni |
autoprocessÁlnév: auto | boolean | Nem | Kihagyja a kezdőképernyőt, és azonnal elindítja a terhelést |
auto_return | boolean | Nem | Visszahí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év | Típus | Kötelező | Leírás |
|---|---|---|---|
pricesÁlnév: line_items | string | Igen | Vesszővel elválasztott árazonosítók mennyiségekkel (pl. price_abc:2,price_xyz:1) |
coupon | string | Nem | A kosárhoz alkalmazható Stripe kuponazonosító |
customerÁlnév: customer_id | string | Nem | Meglévő Stripe ügyfél-azonosító |
email | string | Nem | Ügyfél e-mail-címe a nyugtához |
name | string | Nem | URL-kódolású ügyfélnév |
metadata | string | Nem | Egyéni kulcs-érték párok (URL-kódolású JSON) |
callback | string | Nem | URL, ahová a befejezés után vissza kell térni |
autoprocessÁlnév: auto | boolean | Nem | Kihagyja a kezdőképernyőt, és azonnal elindítja a terhelést |
auto_return | boolean | Nem | Visszahí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év | Típus | Kötelező | Leírás |
|---|---|---|---|
id | string | Igen | Stripe-számlaazonosító (in_ előtaggal kell kezdődnie) |
callback | string | Nem | URL, ahová a befejezés után vissza kell térni. Siker esetén megkapja az invoice_id és a payment_intent_id értékeket. |
metadata | string | Nem | Egyéni kulcs-érték párok (URL-kódolású JSON) egyesítve a PaymentIntent metaadatokkal |
autoprocessÁlnév: auto | boolean | Nem | Kihagyja a kezdőképernyőt, és azonnal elindítja a terhelést |
auto_return | boolean | Nem | Visszahí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ékek | Leírás |
|---|---|---|
status | success | error | cancelled | A tranzakció eredménye |
charge_id | string | Stripe 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_id | string | Stripe terhelési azonosító (ch_) sikeres tranzakció esetén. Csak Androidon. |
invoice_id | string | Stripe számlaazonosító (siker esetén, csak payment://invoice folyamat esetén) |
payment_intent_id | string | Stripe PaymentIntent ID (siker esetén). iOS: csak payment://invoice folyamat. Android: minden kártyás vásárlás. |
error | string | Hibaü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=1000Terhelés leírással
25,00 € terhelése leírással
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryTerhelé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_ABC123xyzTerhelé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%7DAutomatikus 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-completeAutomatikus 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-completeKosá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-paidTeljes példa
Minden paraméter kombinálva a teljesen integrált folyamathoz
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-resultURL-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.
Készen állsz az integrációra?
Töltsd le az alkalmazást, és kezdd el tesztelni az integrációdat még ma!