API kehittäjille

Integroi ja mukauta

Käynnistä Payment for Stripe omasta sovelluksestasi tai verkkosivustoltasi URL-skeemoilla ja hallitse suoraan Stripe-hallintapaneelista, mitkä tuotteet näkyvät sovelluksessa.

Integrointi URL-skeemoilla

Käynnistä veloituksia sovelluksestasi tai verkkosivustoltasi, välitä asiakastietoja ja käsittele takaisinkutsut.

Piilota tuotteita metadatalla

Pidä vain verkossa myytävät tuotteet poissa sovelluksesta yhdellä metadata-avaimella.

Integrointi URL-skeemoilla

Näin se toimii

Sovelluksesi avaa payment:// URL-osoitteen parametreineen

Payment for Stripe käynnistyy ja käsittelee tapahtuman

Kun tapahtuma on valmis, sovellus ohjaa takaisinkutsu-URL-osoitteeseesi tuloksen kanssa

Päätepisteet

Luo veloitus

payment://new?

Käsittele kertaluonteinen maksu summalla, valuutalla ja kuvauksella.

Parametrit

Nimi	Tyyppi	Pakollinen	Kuvaus
`amount`	integer	Kyllä	Summa sentteinä (esim. 1000 = 10,00 dollaria)
`currency`	string	Ei	Kolmikirjaiminen ISO-valuuttakoodi (oletus: USD)
`description`	string	Ei	URL-koodattu veloituksen kuvaus
`customer`	string	Ei	Olemassa oleva Stripe-asiakastunnus
`email`	string	Ei	Asiakkaan sähköpostiosoite kuittia varten
`name`	string	Ei	URL-koodattu asiakkaan nimi
`metadata`	string	Ei	Mukautetut avain-arvo-parit (URL-koodattu JSON)
`callback`	string	Ei	URL-osoite, johon palataan valmistumisen jälkeen
`autoprocess`	boolean	Ei	Ohita aloitusnäyttö ja aloita veloitus heti
`auto_return`	boolean	Ei	Käynnistä takaisinkutsu tuloksen latautuessa sen sijaan, että odottaisi kauppiaan sulkevan tulosvalintaikkunan. Oletusarvo on false.

Luo lasku

payment://cart?

Luo Stripe-lasku, joka sisältää tuoteluettelosi rivikohtia.

Parametrit

Nimi	Tyyppi	Pakollinen	Kuvaus
`prices`	string	Kyllä	Pilkuilla erotetut hintatunnukset määrien kanssa (esim. price_abc:2, price_xyz:1)
`customer`	string	Ei	Olemassa oleva Stripe-asiakastunnus
`email`	string	Ei	Asiakkaan sähköpostiosoite kuittia varten
`name`	string	Ei	URL-koodattu asiakkaan nimi
`callback`	string	Ei	URL-osoite, johon palataan valmistumisen jälkeen
`auto_return`	boolean	Ei	Käynnistä takaisinkutsu tuloksen latautuessa sen sijaan, että odottaisi kauppiaan sulkevan tulosvalintaikkunan. Oletusarvo on false.

Maksa olemassa oleva lasku (vain iOS)

payment://invoice?

Ota kasvokkain vastaan maksu olemassa olevaan Stripe-laskuun. Summa, valuutta, asiakas ja vero tulevat laskulta. Niiden korvaaminen muilla arvoilla hylätään. Kauppias ottaa maksun kortinlukijalla / Tap to Pay -toiminnolla / käsin syöttämällä; onnistuneen maksun jälkeen lasku merkitään maksetuksi Stripen ulkopuolella ja linkitetään charge_id- ja payment_intent_id-metatietojen kautta. Laskut, joissa on tilaus tai default_payment_method tai joiden tila ei ole avoin, hylätään selkeällä virheilmoituksella.

Parametrit

Nimi	Tyyppi	Pakollinen	Kuvaus
`id`	string	Kyllä	Stripe-laskun tunnus (alkaa in_-merkillä)
`callback`	string	Ei	URL-osoite, johon palataan valmistumisen jälkeen. Vastaanottaa invoice_id:n ja payment_intent_id:n onnistumisen jälkeen.
`metadata`	string	Ei	Mukautetut avain-arvo-parit (URL-koodattu JSON) yhdistettynä PaymentIntent-metatietoihin
`autoprocess`	boolean	Ei	Ohita aloitusnäyttö ja aloita veloitus heti
`auto_return`	boolean	Ei	Käynnistä takaisinkutsu tuloksen latautuessa sen sijaan, että odottaisi kauppiaan sulkevan tulosvalintaikkunan. Oletusarvo on false.

Takaisinkutsujen käsittely

Kun maksutapahtuma on valmis, Payment for Stripe ohjaa takaisinkutsu-URL-osoitteeseesi, jonka kyselyparametrit osoittavat tuloksen. Oletusarvoisesti uudelleenohjaus käynnistyy sen jälkeen, kun kauppias sulkee tulosikkunan, jotta hän voi suorittaa veloituksen jälkeisiä toimia (lähettää kuitin sähköpostitse, hyvittää maksun). Anna parametriksi auto_return=true, jotta uudelleenohjaus käynnistyy heti, kun tulos on tiedossa. Tuettu iOS:llä ja Androidilla.

Takaisinkutsuparametrit

Parametri	Arvot	Kuvaus
`status`	success \| error \| cancelled	Tapahtuman tulos
`charge_id`	string	Stripen veloitustunnus (kun tapahtuma onnistuu)
`invoice_id`	string	Stripe-laskun tunnus (kun tapahtuma onnistuu, vain payment://invoice-kulussa)
`payment_intent_id`	string	Stripen PaymentIntent-tunnus (kun tapahtuma onnistuu, vain payment://invoice-kulussa)
`error`	string	Virheilmoitus (virheen sattuessa)

Esimerkkejä

Yksinkertainen veloitus

Veloita 10,00 dollaria pelkällä summalla

payment://new?amount=1000

Veloitus kuvauksella

Veloita 25,00 € kuvauksen kanssa

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

Veloita uudelta asiakkaalta

Veloita 50,00 dollaria ja luo asiakastietue

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

Veloita olemassa olevalta asiakkaalta

Veloita 75,00 dollaria olemassa olevalta Stripe-asiakkaalta

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

Veloita metadatan avulla

Veloita 100,00 dollaria ja lisää omia metatietoja kirjanpitoasi varten

payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7D

Automaattinen käsittely takaisinkutsun avulla

Ohita aloitusnäyttö ja palaa sovellukseesi, kun tapahtuma on valmis

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

Automaattinen paluu tuloksen valmistuttua

Käynnistä takaisinkutsu heti, kun tulos on tiedossa, sen sijaan, että odottaisit kauppiaan sulkevan tulosvalintaikkunan.

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

Lasku, jossa on rivejä

Luo lasku Stripe-tuoteluettelosi tuotteista

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

Maksa olemassa oleva lasku (iOS)

Ota kasvokkain maksu olemassa olevasta Stripe-laskusta. Palauttaa invoice_id:n ja payment_intent_id:n, jos maksu onnistuu.

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

Täydellinen esimerkki

Kaikki parametrit yhdistettynä täysin integroituun kulkuun

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-koodaus

Muista URL-koodata erikoismerkit parametriarvoissa. Välilyönneistä tulee %20, aaltosulkeista %7B ja %7D.

Piilota tuotteita metadatalla

Tuotteiden piilottaminen sovelluksesta

Sovellus näyttää Stripe-tilisi tuotteet ja hinnat. Jos haluat pitää jonkin niistä poissa sovelluksesta (esimerkiksi tuotteet, joita myyt vain verkkokaupassasi), lisää tämä metadata-avain tuotteelle tai hinnalle Stripe-hallintapaneelissa:

payment_hidden = true

Tuotteella: piilottaa tuotteen ja kaikki sen hinnat.

Hinnalla: piilottaa vain kyseisen hinnan.

Poista avain tai aseta se arvoon false näyttääksesi sen uudelleen. Muutokset tulevat voimaan, kun sovellus lataa tuoteluettelosi seuraavan kerran.

Ostoskorilinkit toimivat edelleen

Piilottaminen vaikuttaa vain sovelluksen tuoteluetteloon. payment://cart-URL-osoitteet, jotka viittaavat piilotettuun hintaan, toimivat edelleen, eivätkä olemassa olevat tilaukset muutu.

Oletko valmis integroimaan?

Lataa sovellus ja aloita integraatiosi testaaminen jo tänään.

Lataa iOS:lle Lataa Androidille

Ota yhteyttä tukeen