API za razvojne programere
Integrirajte i prilagodite
Pokrenite Payment for Stripe iz vlastite aplikacije ili web stranice s URL shemama i kontrolirajte koji se proizvodi pojavljuju u aplikaciji izravno s vaše Stripe nadzorne ploče.
Integracija sa shemama URL-ova
Kako funkcionira
Vaša aplikacija otvara payment:// URL s parametrima
Payment for Stripe se pokreće i obrađuje transakciju
Nakon završetka, aplikacija preusmjerava na vaš URL povratnog poziva s rezultatom
Krajnje točke
Napravi naplatu
payment://new?Obradite jednokratno plaćanje s iznosom, valutom i opisom.
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
amount | integer | Da | Iznos u centima (npr. 1000 = 10,00 USD) |
currency | string | Ne | Troslovni ISO kod valute (zadano: trenutna valuta aplikacije) |
description | string | Ne | Opis naplate kodiran URL-om |
customerAlias: customer_id | string | Ne | ID postojećeg Stripe kupca |
email | string | Ne | E-pošta kupca za potvrdu |
name | string | Ne | URL-kodirano ime kupca |
metadata | string | Ne | Prilagođeni parovi ključ-vrijednost (URL-kodirani JSON) |
callback | string | Ne | URL za povratak nakon završetka |
autoprocessAlias: auto | boolean | Ne | Preskoči početni zaslon i odmah pokreni naplatu |
auto_return | boolean | Ne | Aktiviraj povratni poziv kada se rezultat učita umjesto čekanja da trgovac zatvori dijalog s rezultatima. Zadana vrijednost je "false". |
Prodajte artikle iz svog kataloga
payment://cart?Napunite košaricu cijenama iz svog Stripe kataloga za osobnu naplatu. Prodaja se sprema kao plaćeni Stripe račun. Kupcu se ništa ne šalje.
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
pricesAlias: line_items | string | Da | ID-ovi cijena odvojeni zarezima, s količinama (npr. price_abc:2,price_xyz:1) |
coupon | string | Ne | ID kupona Stripe za primjenu u košarici |
customerAlias: customer_id | string | Ne | ID postojećeg Stripe kupca |
email | string | Ne | E-pošta kupca za potvrdu |
name | string | Ne | URL-kodirano ime kupca |
metadata | string | Ne | Prilagođeni parovi ključ-vrijednost (URL-kodirani JSON) |
callback | string | Ne | URL za povratak nakon završetka |
autoprocessAlias: auto | boolean | Ne | Preskoči početni zaslon i odmah pokreni naplatu |
auto_return | boolean | Ne | Aktiviraj povratni poziv kada se rezultat učita umjesto čekanja da trgovac zatvori dijalog s rezultatima. Zadana vrijednost je "false". |
Platite postojeću fakturu
payment://invoice?Naplatite osobno na temelju postojećeg Stripe računa. Iznos, valuta, kupac i porez potječu s računa. Poništavanje bilo kojeg od tih podataka se odbija. Trgovac prisloni karticu putem čitača / Tap to Pay / ručno unese; u slučaju uspjeha, račun se označava kao plaćen izvan opsega i povezuje putem metapodataka charge_id i payment_intent_id. Računi s pretplatama, default_payment_method ili statusom plaćeno, nevažeće ili nenaplativo odbijaju se s pogreškom na koju se može poduzeti mjera. Nacrti računa: iOS ih prvo finalizira, Android ih odbija s invoice_state_changed.
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
id | string | Da | ID Stripe fakture (mora započeti s in_) |
callback | string | Ne | URL za povratak nakon završetka. U slučaju uspjeha prima invoice_id i payment_intent_id. |
metadata | string | Ne | Prilagođeni parovi ključ-vrijednost (URL-kodirani JSON) koji se spajaju u metapodatke PaymentIntenta |
autoprocessAlias: auto | boolean | Ne | Preskoči početni zaslon i odmah pokreni naplatu |
auto_return | boolean | Ne | Aktiviraj povratni poziv kada se rezultat učita umjesto čekanja da trgovac zatvori dijalog s rezultatima. Zadana vrijednost je "false". |
Obrada povratnih poziva
Kada se transakcija završi, Payment for Stripe preusmjerava na vaš URL povratnog poziva s parametrima upita koji sadrže rezultat. Prema zadanim postavkama preusmjeravanje se aktivira nakon što trgovac zatvori dijalog s rezultatom, kako bi mogao poduzeti radnje nakon naplate (poslati potvrdu e-poštom, izvršiti povrat novca). Proslijedite auto_return=true da bi se preusmjeravanje aktiviralo čim je rezultat poznat. Podržano na iOS-u i Androidu.
Parametri povratnog poziva
| Parametar | Vrijednosti | Opis |
|---|---|---|
status | success | error | cancelled | Rezultat transakcije |
charge_id | string | ID naplate Stripe (u slučaju uspjeha). iOS šalje ID naplate (ch_). Android šalje ID namjere plaćanja (pi_) i stavlja ID naplate u stripe_charge_id. |
stripe_charge_id | string | ID naplate Stripe (ch_) u slučaju uspjeha. Samo za Android. |
invoice_id | string | ID Stripe fakture (u slučaju uspjeha, samo tijek payment://invoice) |
payment_intent_id | string | Stripe PaymentIntent ID (u slučaju uspjeha). iOS: samo payment://invoice tijek. Android: svaka prodaja karticom. |
error | string | Poruka o pogrešci (u slučaju greške) |
Naplata je izvršena, ali račun nije mogao biti označen kao plaćen: iOS vraća status=error s charge_id, invoice_id i payment_intent_id. Android vraća status=success s invoice_reconciliation_failed=true.
Stara polja, sačuvana za starije integracije: success, amount, currency, chargeId, cancelled, error[message]. Nove integracije trebaju čitati gornja polja.
Primjeri
Jednostavna naplata
Naplatite 10,00 USD samo s iznosom
payment://new?amount=1000Naplata s opisom
Naplatite 25,00 € s opisom
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryNaplata s novim kupcem
Naplatite 50,00 USD i stvorite zapis o kupcu
payment://new?amount=5000&name=John%20Smith&[email protected]Naplata postojećem kupcu
Naplatite 75,00 USD postojećem Stripe kupcu
payment://new?amount=7500&customer=cus_ABC123xyzNaplata s metapodacima
Naplatite 100,00 USD s prilagođenim metapodacima za svoje zapise
payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7DAutomatska obrada s povratnim pozivom
Preskočite početni zaslon i vratite se u svoju aplikaciju po završetku
payment://new?amount=3500&autoprocess=true&callback=myapp://payment-completeAutomatski povratak po rezultatu
Pokrenite povratni poziv čim je rezultat poznat, umjesto da se čeka da trgovac zatvori dijalog s rezultatom
payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-completeKošarica s stavkama
Naplata za proizvode iz vašeg Stripe kataloga
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Platite postojeću fakturu
Naplatite uživo postojeću Stripe fakturu. U slučaju uspjeha vraća invoice_id i payment_intent_id.
payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paidPotpuni primjer
Svi parametri zajedno za potpuno integrirani tijek
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-resultKodiranje URL-ova
Ne zaboravite URL-kodirati posebne znakove u vrijednostima parametara. Razmaci postaju %20, vitičaste zagrade postaju %7B i %7D.
Spremni za integraciju?
Preuzmite aplikaciju i počnite testirati svoju integraciju već danas.