Overzicht
PassFlow (PassFlow API op /api/v1/pass-flows, alias /api/v1/passflows) is Passinstance' gehoste, white-label selfservice-inschrijf- en check-outengine (PassFlowType: REGISTRATION, CHECKOUT, RECHARGE, CLAIM, UPDATE, REDEMPTION, CUSTOM; PassFlowStatus: DRAFT, PUBLISHED, PAUSED, ARCHIVED). Klanten bezoeken /f/:url, doorlopen instelbare intakestappen—waaronder aangepaste formuliervelden, botbescherming (SpamProtectionMode: NONE, RECAPTCHA), e-mail-/sms-OTP-verificatie en optioneel afrekenen—en installeren direct hun Apple Wallet- of Google Wallet-pas.
Systeemarchitectuur: PassFlow-pipeline & betaalgateways
PassFlow-stappen & toestandsmachine voor inzendingen
In Passinstance Dashboard en PassFlow API (PassFlowStepType: INTRODUCTION, FORM, PASS_LOOKUP, AUTHENTICATION, PRODUCT_SELECTION, PAYMENT, REVIEW, PROCESSING, CONFIRMATION, PASS_DELIVERY, ERROR, CUSTOM):
Openbare stap (stepFlow.ts) | Fasenaam | Uitvoeringsgedrag & validatieregels |
|---|---|---|
1. FormStep | Klantregistratieformulier | Toont zichtbare sjablooneigenschappen met verplichte/regex-validatie en AVG-toestemmingsvakjes. Roept GET /api/v1/pass-flows/public/:url/csrf-token aan alvorens POST /api/v1/pass-flows/public/:url/generate (userData, recaptchaToken?) in te dienen. |
2. EmailStep | Contact & ontdubbeling | Vraagt/bevestigt het primaire e-mailadres of telefoonnummer en handhaaft externalId- / ontdubbelingsinstellingen. |
3. OtpStep | Verificatie met eenmalige code | (Optioneel) Verstuurt/verifieert een tijdelijke OTP-code via POST /api/v1/pass-flows/public/:url/otp/send, /otp/resend en /otp/verify. |
4. PaymentStep | Geïntegreerde betaalcheckout | (Optioneel) Leest GET /api/v1/pass-flows/public/:url/payment-config uit en int de betaling via Stripe, PayPal, Paystack, MTN Mobile Money of Orange Money. |
5. PassStep | Directe wallet-levering | Toont knoppen voor Toevoegen aan Apple Wallet / Toevoegen aan Google Wallet, QR-overdracht en Begeleide PassTour-overlays. |
Belangrijk: Inzendingen volgen
PassFlowSubmissionStatus(STARTED,SUBMITTED,AWAITING_PAYMENT,PAYMENT_PENDING,PROCESSING,COMPLETED,FAILED,REJECTED,EXPIRED,CANCELLED). Wanneer OTP of betaling is ingeschakeld, vindt activering van de wallet-pas pas plaats nadat de verificatie succesvol is afgerond.
Geïntegreerde betaalgateways voor betaalde passen
PassFlow ondersteunt vijf regionale en wereldwijde betaalverwerkers met specifieke openbare initialisatie- en webhook-endpoints:
| Betaalprovider | Openbaar initialisatie-endpoint | Ondersteunde betaalmethoden & regio's |
|---|---|---|
| Stripe | POST /api/v1/pass-flows/public/:url/payment-intent | Credit-/debitcards, Apple Pay, Google Pay, SEPA, Klarna (Wereldwijd) |
| PayPal | POST /api/v1/pass-flows/public/:url/paypal-order | PayPal Wallet, Pay Later, Venmo (Wereldwijd) |
| Paystack | POST /api/v1/pass-flows/public/:url/paystack/initialize | Kaarten, bankoverschrijving, USSD, Mobile Money (Nigeria, Ghana, Kenia, Zuid-Afrika) |
| MTN Mobile Money | POST /api/v1/pass-flows/public/:url/mtn-momo/request-to-pay | Push USSD mobiele wallet-goedkeuring (West- & Centraal-Afrika) |
| Orange Money | POST /api/v1/pass-flows/public/:url/orange-money/initiate | Orange Money web-/mobiele OTP-checkout (Franstalig Afrika & Europa) |
Voorbeeld: een Stripe Payment Intent initialiseren in PassFlow
/api/v1/pass-flows/public/summer-vip-festival/payment-intent
{
"email": "claire.dubois@example.com",
"userData": {
"firstName": "Claire",
"lastName": "Dubois",
"ticketTier": "VIP All-Access"
}
}
HTTP-respons (201 Created)
{
"success": true,
"data": {
"clientSecret": "pi_3Q9xYz2eZvKYlo2C1a2b3c4d_secret_9f8e7d6c5b4a",
"paymentIntentId": "pi_3Q9xYz2eZvKYlo2C1a2b3c4d"
},
"statusCode": 201
}
Voorbeeld: een MTN MoMo Request-to-Pay starten
/api/v1/pass-flows/public/accra-vip-lounge/mtn-momo/request-to-pay
{
"phoneNumber": "+233241234567",
"amount": 150,
"currency": "GHS"
}
PassFlows beheren in het dashboard & via de API
Configureer gehoste PassFlows in het Dashboard onder Distributie -> Pass Flows (/pass-flows), of beheer ze programmatisch via /api/v1/pass-flows:
-
GET /api/v1/pass-flows: Geeft een lijst van alle geconfigureerde PassFlows in de actieve workspace. -
POST /api/v1/pass-flows: Maakt een nieuwe PassFlow aan die is gekoppeld aan een gepubliceerdetemplateId, inclusief een eigenurl-slug,PassFlowType, OTP-instellingen en betaalconfiguratie. -
PATCH /api/v1/pass-flows/:id: Werkt zichtbaarheid van formuliervelden, OTP-vereisten of betaalgatewayconfiguratie bij.
Lees meer over openbare distributiekanalen in Selfservice-distributie en Downloadlinks & PassFlow.
