API pentru dezvoltatori
Integrați și personaliza
Lansează Payment for Stripe din propria aplicație sau site web cu scheme URL și controlează ce produse apar în aplicație direct din Tabloul de bord Stripe.
Integrare cu scheme URL
Cum funcționează
Aplicația ta deschide o plată:// URL cu parametri
Plata pentru Stripe se lansează și procesează tranzacția
La finalizare, aplicația redirecționează către adresa URL de apel invers cu rezultatul
Puncte finale
Creați o taxă
payment://new?Procesați o plată unică cu sumă, monedă și descriere.
Parametri
| Nume | Tip | Necesar | Descriere |
|---|---|---|---|
amount | integer | Da | Sumă în cenți (de exemplu, 1000 = 10,00 USD) |
currency | string | Nu | Cod valutar ISO din trei litere (implicit: USD) |
description | string | Nu | Descrierea taxei codificată prin URL |
customer | string | Nu | ID client Stripe existent |
email | string | Nu | Adresa de e-mail a clientului pentru primire |
name | string | Nu | Numele clientului codificat prin URL |
metadata | string | Nu | Perechi cheie-valoare personalizate (JSON codificat în URL) |
callback | string | Nu | URL la care se poate reveni după finalizare |
autoprocess | boolean | Nu | Sari peste ecranul principal și începe încărcarea imediat |
auto_return | boolean | Nu | Se declanșează un apel invers când se încarcă rezultatul, în loc să aștepte ca comerciantul să închidă caseta de dialog pentru rezultat. Valoarea implicită este falsă. |
Creați o factură
payment://cart?Creați o factură Stripe cu articole din catalogul dvs. de produse.
Parametri
| Nume | Tip | Necesar | Descriere |
|---|---|---|---|
prices | string | Da | ID-uri de preț separate prin virgulă cu cantități (de exemplu, price_abc:2, price_xyz:1) |
customer | string | Nu | ID client Stripe existent |
email | string | Nu | Adresa de e-mail a clientului pentru primire |
name | string | Nu | Numele clientului codificat prin URL |
callback | string | Nu | URL la care se poate reveni după finalizare |
auto_return | boolean | Nu | Se declanșează un apel invers când se încarcă rezultatul, în loc să aștepte ca comerciantul să închidă caseta de dialog pentru rezultat. Valoarea implicită este falsă. |
Plata unei facturi existente (doar pentru iOS)
payment://invoice?Colectați o plată în persoană pentru o factură Stripe existentă. Suma, moneda, clientul și taxa provin din factură. Suprascrierea oricăreia dintre acestea este respinsă. Comerciantul introduce un card prin cititor / Tap to Pay / introducere manuală; în caz de succes, factura este marcată ca plătită în afara benzii și conectată prin metadatele charge_id și payment_intent_id. Facturile cu abonamente, starea default_payment_method sau nedeschisă sunt respinse cu o eroare care poate duce la acțiune.
Parametri
| Nume | Tip | Necesar | Descriere |
|---|---|---|---|
id | string | Da | ID-ul facturii Stripe (trebuie să înceapă cu in_) |
callback | string | Nu | URL la care se poate reveni după finalizare. Primește invoice_id și payment_intent_id în caz de succes. |
metadata | string | Nu | Perechi cheie-valoare personalizate (JSON codificat URL) îmbinate în metadatele PaymentIntent |
autoprocess | boolean | Nu | Sari peste ecranul principal și începe încărcarea imediat |
auto_return | boolean | Nu | Se declanșează un apel invers când se încarcă rezultatul, în loc să se aștepte ca comerciantul să închidă caseta de dialog pentru rezultat. Valoarea implicită este falsă. |
Gestionarea apelurilor inverse
Când tranzacția este finalizată, Payment for Stripe redirecționează către adresa URL de apel invers, cu parametri de interogare care indică rezultatul. În mod implicit, redirecționarea se declanșează după ce comerciantul închide caseta de dialog cu rezultatul, astfel încât să poată lua măsuri ulterioare plății (trimiterea unei chitanțe prin e-mail, rambursare). Transmiteți auto_return=true pentru a se declanșa imediat ce rezultatul este cunoscut. Compatibil cu iOS și Android.
Parametrii de apel invers
| Parametru | Valori | Descriere |
|---|---|---|
status | success | error | cancelled | Rezultatul tranzacției |
charge_id | string | ID-ul plății Stripe (în caz de succes) |
invoice_id | string | ID factură Stripe (în caz de succes, doar fluxul payment://invoice) |
payment_intent_id | string | ID-ul Stripe PaymentIntent (în caz de succes, doar fluxul payment://facture) |
error | string | Mesaj de eroare (în caz de eroare) |
Exemple
Încărcare simplă
Încărcați 10,00 USD cu o singură sumă
payment://new?amount=1000Taxă cu descriere
Taxă de 25,00 € cu o descriere
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryFacturați cu clientul nou
Facturați 50,00 USD și creați o înregistrare client
payment://new?amount=5000&name=John%20Smith&[email protected]Facturați clientul existent
Facturați 75,00 USD unui client Stripe existent
payment://new?amount=7500&customer=cus_ABC123xyzTaxare cu metadate
Taxați cu 100,00 USD pentru metadate personalizate pentru înregistrările dvs.
payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7DProcesare automată cu apel invers
Sari peste ecranul de pornire și revino la aplicație când ai terminat
payment://new?amount=3500&autoprocess=true&callback=myapp://payment-completeReturnare automată a rezultatului
Declanșează apelul invers imediat ce rezultatul este cunoscut, în loc să aștepți ca comerciantul să închidă caseta de dialog cu rezultatul.
payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-completeFactură cu articole individuale
Creați o factură cu produse din catalogul dvs. Stripe
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Plata unei facturi existente (iOS)
Colectați plata în persoană pentru o factură Stripe existentă. Returnează invoice_id și payment_intent_id în caz de succes.
payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paidExemplu complet
Toți parametrii combinați pentru un flux complet integrat
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-resultCodificare URL
Nu uitați să codificați caracterele speciale în valorile parametrilor pentru URL. Spațiile devin %20, acoladele devin %7B și %7D.
Gata să te integrezi?
Descarcă aplicația și începe să testezi integrarea chiar azi.