Skip to content

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ă

1

Aplicația ta deschide o plată:// URL cu parametri

2

Plata pentru Stripe se lansează și procesează tranzacția

3

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

NumeTipNecesarDescriere
amountintegerDaSumă în cenți (de exemplu, 1000 = 10,00 USD)
currencystringNuCod valutar ISO din trei litere (implicit: USD)
descriptionstringNuDescrierea taxei codificată prin URL
customerstringNuID client Stripe existent
emailstringNuAdresa de e-mail a clientului pentru primire
namestringNuNumele clientului codificat prin URL
metadatastringNuPerechi cheie-valoare personalizate (JSON codificat în URL)
callbackstringNuURL la care se poate reveni după finalizare
autoprocessbooleanNuSari peste ecranul principal și începe încărcarea imediat
auto_returnbooleanNuSe 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

NumeTipNecesarDescriere
pricesstringDaID-uri de preț separate prin virgulă cu cantități (de exemplu, price_abc:2, price_xyz:1)
customerstringNuID client Stripe existent
emailstringNuAdresa de e-mail a clientului pentru primire
namestringNuNumele clientului codificat prin URL
callbackstringNuURL la care se poate reveni după finalizare
auto_returnbooleanNuSe 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

NumeTipNecesarDescriere
idstringDaID-ul facturii Stripe (trebuie să înceapă cu in_)
callbackstringNuURL la care se poate reveni după finalizare. Primește invoice_id și payment_intent_id în caz de succes.
metadatastringNuPerechi cheie-valoare personalizate (JSON codificat URL) îmbinate în metadatele PaymentIntent
autoprocessbooleanNuSari peste ecranul principal și începe încărcarea imediat
auto_returnbooleanNuSe 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

ParametruValoriDescriere
statussuccess | error | cancelledRezultatul tranzacției
charge_idstringID-ul plății Stripe (în caz de succes)
invoice_idstringID factură Stripe (în caz de succes, doar fluxul payment://invoice)
payment_intent_idstringID-ul Stripe PaymentIntent (în caz de succes, doar fluxul payment://facture)
errorstringMesaj de eroare (în caz de eroare)

Exemple

Încărcare simplă

Încărcați 10,00 USD cu o singură sumă

payment://new?amount=1000

Taxă cu descriere

Taxă de 25,00 € cu o descriere

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

Facturaț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_ABC123xyz

Taxare 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%7D

Procesare 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-complete

Returnare 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-complete

Factură 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-paid

Exemplu complet

Toți parametrii combinați pentru un flux complet integrat

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

Codificare URL

Nu uitați să codificați caracterele speciale în valorile parametrilor pentru URL. Spațiile devin %20, acoladele devin %7B și %7D.

Ascundeți produsele cu metadate

Ascunderea produselor din aplicație

Aplicația listează produsele și prețurile din contul tău Stripe. Pentru a împiedica accesul aplicației la unul dintre acestea (de exemplu, articole vândute doar prin magazinul tău online), adaugă această cheie de metadate la produs sau preț în Tabloul de bord Stripe:

payment_hidden = true

Pe un produs: ascunde produsul și toate prețurile sale.

Pe un preț: ascunde doar prețul respectiv.

Eliminați cheia sau setați-o la fals pentru a o afișa din nou. Modificările se aplică data viitoare când aplicația încarcă lista de produse.

Linkurile pentru coș continuă să funcționeze

Ascunderea afectează doar lista de produse din cadrul aplicației. Adresele URL payment://cart care fac referire la un preț ascuns funcționează în continuare, iar abonamentele existente nu sunt afectate.

Gata să te integrezi?

Descarcă aplicația și începe să testezi integrarea chiar azi.