Ontwikkelaars-API
Integreren en aanpassen
Start Payment for Stripe vanuit je eigen app of website met URL-schema's, en bepaal rechtstreeks vanuit je Stripe-dashboard welke producten in de app verschijnen.
Integreren met URL-schema's
Hoe het werkt
Je app opent een payment:// URL met parameters
Payment for Stripe wordt gestart en verwerkt de transactie.
Na voltooiing stuurt de app je door naar je callback-URL met het resultaat.
Endpoints
Een betaling aanmaken
payment://new?Verwerk een eenmalige betaling met bedrag, valuta en omschrijving.
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
amount | integer | Ja | Bedrag in centen (bijv. 1000 = $10,00) |
currency | string | Nee | Drieletterige ISO-valutacode (standaard: de huidige valuta van de app) |
description | string | Nee | URL-gecodeerde betalingsomschrijving |
customerAlias: customer_id | string | Nee | Bestaand Stripe-klant-ID |
email | string | Nee | E-mailadres van de klant voor de bon |
name | string | Nee | URL-gecodeerde klantnaam |
metadata | string | Nee | Aangepaste sleutel-waardeparen (URL-gecodeerde JSON) |
callback | string | Nee | URL om na voltooiing naar terug te keren |
autoprocessAlias: auto | boolean | Nee | Sla het startscherm over en start de betaling direct. |
auto_return | boolean | Nee | Roep de callbackfunctie aan zodra het resultaat is geladen, in plaats van te wachten tot de verkoper het resultaatdialoogvenster sluit. Standaardwaarde: false. |
Verkoop artikelen uit uw catalogus
payment://cart?Vul het winkelmandje met prijzen uit je Stripe catalogus voor een afrekening ter plaatse. De verkoop wordt opgeslagen als een betaalde Stripe factuur. Er wordt niets naar de klant verzonden.
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
pricesAlias: line_items | string | Ja | Door komma's gescheiden prijs-ID's met aantallen (bijv. price_abc:2,price_xyz:1) |
coupon | string | Nee | Stripe coupon-ID die u in uw winkelmandje kunt toepassen |
customerAlias: customer_id | string | Nee | Bestaand Stripe-klant-ID |
email | string | Nee | E-mailadres van de klant voor de bon |
name | string | Nee | URL-gecodeerde klantnaam |
metadata | string | Nee | Aangepaste sleutel-waardeparen (URL-gecodeerde JSON) |
callback | string | Nee | URL om na voltooiing naar terug te keren |
autoprocessAlias: auto | boolean | Nee | Sla het startscherm over en start de betaling direct. |
auto_return | boolean | Nee | Roep de callbackfunctie aan zodra het resultaat is geladen, in plaats van te wachten tot de verkoper het resultaatdialoogvenster sluit. Standaardwaarde: false. |
Een bestaande factuur betalen
payment://invoice?Een betaling ter plaatse innen op basis van een bestaande Stripe factuur. Het bedrag, de valuta, de klant en de belasting worden overgenomen van de factuur. Het overschrijven van een van deze gegevens wordt geweigerd. De verkoper voert een kaartbetaling in via een kaartlezer / Tap to Pay / handmatige invoer; bij succes wordt de factuur automatisch als betaald gemarkeerd en gekoppeld via de metadata charge_id en payment_intent_id. Facturen met abonnementen, default_payment_method of een betaalde, ongeldige of oninbare status worden geweigerd met een foutmelding. Conceptfacturen: iOS finaliseert ze eerst, Android weigert ze met invoice_state_changed.
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
id | string | Ja | Stripe-factuur-ID (moet beginnen met in_) |
callback | string | Nee | URL waarnaar na voltooiing moet worden teruggekeerd. Ontvangt invoice_id en payment_intent_id bij succes. |
metadata | string | Nee | Aangepaste sleutel-waardeparen (URL-gecodeerde JSON) samengevoegd in de PaymentIntent-metadata. |
autoprocessAlias: auto | boolean | Nee | Sla het startscherm over en start de betaling direct. |
auto_return | boolean | Nee | Roep de callbackfunctie aan zodra het resultaat is geladen, in plaats van te wachten tot de verkoper het resultaatdialoogvenster sluit. Standaardwaarde: false. |
Het afhandelen van callbacks
Wanneer de transactie is voltooid, stuurt Payment for Stripe je door naar je callback-URL met queryparameters die het resultaat aangeven. Standaard wordt de redirect geactiveerd nadat de verkoper het resultaatdialoogvenster heeft gesloten, zodat deze acties na de betaling kan uitvoeren (een bon per e-mail versturen, een terugbetaling doen). Geef auto_return=true door om de redirect te activeren zodra het resultaat bekend is. Ondersteund op iOS en Android.
Callbackparameters
| Parameter | Waarden | Beschrijving |
|---|---|---|
status | success | error | cancelled | Resultaat van de transactie |
charge_id | string | Stripe-betalings-ID (bij succes). iOS verzendt de betalings-ID (ch_). Android verzendt de PaymentIntent-ID (pi_) en plaatst de betalings-ID in stripe_charge_id. |
stripe_charge_id | string | Stripe betalings-ID (ch_) bij succesvolle betaling. Alleen voor Android. |
invoice_id | string | Stripe-factuur-ID (alleen bij succes, in het betalingsproces via payment://invoice) |
payment_intent_id | string | Stripe PaymentIntent ID (bij succes). iOS: alleen voor de payment://invoice-flow. Android: voor elke kaarttransactie. |
error | string | Foutmelding (bij een fout) |
De betaling is wel geregistreerd, maar de factuur kon niet als betaald worden gemarkeerd: iOS retourneert status=error met charge_id, invoice_id en payment_intent_id. Android retourneert status=success met invoice_reconciliation_failed=true.
Verouderde velden, bewaard voor oudere integraties: success, amount, currency, chargeId, cancelled, error[message]. Nieuwe integraties moeten de bovenstaande velden lezen.
Voorbeelden
Eenvoudige betaling
Breng $10,00 in rekening met slechts een bedrag.
payment://new?amount=1000Betaling met omschrijving
Breng €25,00 in rekening met een omschrijving.
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryBetaling met nieuwe klant
Breng $50,00 in rekening en maak een klantrecord aan.
payment://new?amount=5000&name=John%20Smith&[email protected]Betaling bij bestaande klant
Breng een bestaande Stripe-klant $75,00 in rekening.
payment://new?amount=7500&customer=cus_ABC123xyzBetaling met metadata
Breng $100,00 in rekening met aangepaste metadata voor je administratie.
payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7DAutomatische verwerking met callback
Sla het startscherm over en keer terug naar je app als je klaar bent.
payment://new?amount=3500&autoprocess=true&callback=myapp://payment-completeAutomatische terugkeer bij resultaat
Activeer de callback zodra het resultaat bekend is, in plaats van te wachten tot de verkoper het resultaatdialoogvenster sluit.
payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-completeWinkelwagen met artikelen per artikel
Reken kosten af voor producten uit je Stripe catalogus
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Betaal een bestaande factuur
Neem een betaling ter plaatse aan voor een bestaande Stripe-factuur. Geeft bij succes invoice_id en payment_intent_id terug.
payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paidVolledig voorbeeld
Alle parameters gecombineerd voor een volledig geïntegreerde flow.
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-resultURL-codering
Vergeet niet speciale tekens in parameterwaarden te URL-coderen. Spaties worden %20, accolades worden %7B en %7D.
Klaar voor integratie?
Download de app en begin vandaag nog met het testen van je integratie.