Skip to content
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-skeemoillaKäynnistä veloituksia sovelluksestasi tai verkkosivustoltasi, välitä asiakastietoja ja käsittele takaisinkutsut.Piilota tuotteita metadatallaPidä vain verkossa myytävät tuotteet poissa sovelluksesta yhdellä metadata-avaimella.
Integrointi URL-skeemoilla

Näin se toimii

  1. 1Sovelluksesi avaa payment:// URL-osoitteen parametreineen
  2. 2Payment for Stripe käynnistyy ja käsittelee tapahtuman
  3. 3Kun 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

  • amountintegerPakollinenSumma sentteinä (esim. 1000 = 10,00 dollaria)
  • currencystringKolmikirjaiminen ISO-valuuttakoodi (oletus: sovelluksen nykyinen valuutta)
  • descriptionstringURL-koodattu veloituksen kuvaus
  • customerstringAlias: customer_idOlemassa oleva Stripe-asiakastunnus
  • emailstringAsiakkaan sähköpostiosoite kuittia varten
  • namestringURL-koodattu asiakkaan nimi
  • metadatastringMukautetut avain-arvo-parit (URL-koodattu JSON)
  • callbackstringURL-osoite, johon palataan valmistumisen jälkeen
  • autoprocessbooleanAlias: autoOhita aloitusnäyttö ja aloita veloitus heti
  • auto_returnbooleanKäynnistä takaisinkutsu tuloksen latautuessa sen sijaan, että odottaisi kauppiaan sulkevan tulosvalintaikkunan. Oletusarvo on false.

Myy tuotteita luettelostasi

payment://cart?Täytä ostoskori Stripe-luettelosi hinnoilla ja maksa paikan päällä. Myynti tallennetaan maksettuna Stripe laskuna. Asiakkaalle ei lähetetä mitään.

Parametrit

  • pricesstringPakollinenAlias: line_itemsPilkuilla erotetut hintatunnukset määrien kanssa (esim. price_abc:2, price_xyz:1)
  • couponstringStripe kuponkitunnus ostoskoriin käytettäväksi
  • customerstringAlias: customer_idOlemassa oleva Stripe-asiakastunnus
  • emailstringAsiakkaan sähköpostiosoite kuittia varten
  • namestringURL-koodattu asiakkaan nimi
  • metadatastringMukautetut avain-arvo-parit (URL-koodattu JSON)
  • callbackstringURL-osoite, johon palataan valmistumisen jälkeen
  • autoprocessbooleanAlias: autoOhita aloitusnäyttö ja aloita veloitus heti
  • auto_returnbooleanKäynnistä takaisinkutsu tuloksen latautuessa sen sijaan, että odottaisi kauppiaan sulkevan tulosvalintaikkunan. Oletusarvo on false.

Maksa olemassa oleva lasku

payment://invoice?Peri maksu henkilökohtaisesti olemassa olevaa Stripe laskua vastaan. Summa, valuutta, asiakas ja vero tulevat laskulta. Näiden ohittaminen hylätään. Kauppias syöttää kortille maksun lukijan / Tap to Pay / manuaalisen syötön kautta; onnistumisen jälkeen lasku merkitään maksetuksi kaistan ulkopuolella ja linkitetään charge_id- ja payment_intent_id-metatietojen kautta. Laskut, joissa on tilauksia, default_payment_method tai maksettu, mitätöity tai perimätön tila, hylätään ja näytetään toimenpiteitä vaativa virhe. Luonnoslaskut: iOS viimeistelee ne ensin, Android hylkää ne ja näyttää invoice_state_changed-virheen.

Parametrit

  • idstringPakollinenStripe-laskun tunnus (alkaa in_-merkillä)
  • callbackstringURL-osoite, johon palataan valmistumisen jälkeen. Vastaanottaa invoice_id:n ja payment_intent_id:n onnistumisen jälkeen.
  • metadatastringMukautetut avain-arvo-parit (URL-koodattu JSON) yhdistettynä PaymentIntent-metatietoihin
  • autoprocessbooleanAlias: autoOhita aloitusnäyttö ja aloita veloitus heti
  • auto_returnbooleanKä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

  • statussuccess | error | cancelledTapahtuman tulos
  • charge_idstringStripe-veloitustunnus (onnistuttuaan). iOS lähettää veloitustunnuksen (ch_). Android lähettää PaymentIntent-tunnuksen (pi_) ja sijoittaa veloitustunnuksen stripe_charge_id-kenttään.
  • stripe_charge_idstringStripe-maksutunnus (ch_) onnistumisen jälkeen. Vain Androidille.
  • invoice_idstringStripe-laskun tunnus (kun tapahtuma onnistuu, vain payment://invoice-kulussa)
  • payment_intent_idstringStripe PaymentIntent ID (onnistuttuaan). iOS: vain payment://invoice -työnkulku. Android: jokainen korttiosto.
  • errorstringVirheilmoitus (virheen sattuessa)
Veloitus kirjattu, mutta laskua ei voitu merkitä maksetuksi: iOS palauttaa status=error sekä charge_id, invoice_id ja payment_intent_id. Android palauttaa status=success sekä invoice_reconciliation_failed=true.Vanhat kentät, säilytetään vanhemmille integraatioille: success, amount, currency, chargeId, cancelled, error[message]. Uusien integraatioiden tulisi lukea yllä olevat kentät.

Esimerkkejä

  • Yksinkertainen veloitus

    Veloita 10,00 dollaria pelkällä summallapayment://new?amount=1000

  • Veloitus kuvauksella

    Veloita 25,00 € kuvauksen kanssapayment://new?amount=2500&currency=eur&description=Coffee%20and%20pastry

  • Veloita uudelta asiakkaalta

    Veloita 50,00 dollaria ja luo asiakastietuepayment://new?amount=5000&name=John%20Smith&email=[email protected]

  • Veloita olemassa olevalta asiakkaalta

    Veloita 75,00 dollaria olemassa olevalta Stripe-asiakkaaltapayment://new?amount=7500&customer=cus_ABC123xyz

  • Veloita metadatan avulla

    Veloita 100,00 dollaria ja lisää omia metatietoja kirjanpitoasi vartenpayment://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 valmispayment://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

  • Ostoskori rivinimikkeillä

    Veloita Stripe-luettelosi tuotteistapayment://cart?prices=price_coffee:2,price_muffin:1&email=[email protected]

  • Maksa olemassa oleva lasku

    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 kulkuunpayment://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-koodausMuista 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 edelleenPiilottaminen 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 ilmaiseksi (iOS)Ota yhteyttä tukeen