Developer documentation

Integrate PayShare split-pay on your own payment rails (Stripe, Adyen, etc.). PayShare orchestrates the split; you capture funds and report outcomes.

PayShare is an API-driven split-payment platform. A host starts a session; guests join via link or QR and each pays their share. Funds stay on your PSP — PayShare never holds your Stripe keys.

Recommended flow (Mode 2)

  1. Your backend POST /api/v1/payments/sessions (amount, currency, merchantOrderRef, optional platformContextId).
  2. Redirect the host to PayShare hosted UI (sessionUrl from response).
  3. On Pay, PayShare POSTs signed create-payment to your server; you return a PSP redirectUrl (e.g. Stripe Checkout).
  4. After each payer completes on your PSP, your stripe-success bridge calls record-payment, then 302 back to PayShare.
  5. When all slots are paid, PayShare emits PAYSHARE_SESSION_COMPLETED — fulfil the order once, using eventId for idempotency.

What you build

PieceOwner
Session create (API key)Your server
Create-payment route (HMAC verify → Checkout URL)Your server
Stripe success bridge (retrieve → record-payment → 302)Your server
Completion webhook handlerYour server
Split UI (host hub, guest join, pay)PayShare hosted app

App URLs

  • API base: https://app.payshare.nz
  • Partner dashboard & Integration Wizard: https://app.payshare.nz/partner
  • Never send PAYSHARE_API_KEY to the browser.