Use this guide when building a custom customer-facing app that needs to accept payments through Storeganise. It covers how to use the custom billing API to let customers register and view their payment methods, regardless of which payment provider you use.
How it works
The custom billing API sits as a gateway-agnostic layer on top of your installed payment Add-on — whether that's Stripe, Mollie, Bpoint, Fortis, or another provider. Your app calls a single set of endpoints regardless of which Add-on is in use. Storeganise handles the hosted checkout UI, tokenisation, and storage of payment details on the provider's side.There are two operations your app would usually support:
Registering a new payment method: redirect the customer to a hosted checkout page, which handles the entire flow and redirects back to your app when done.
Listing saved payment methods: fetch the customer's stored cards or bank accounts to display in your app's billing section.
Prerequisites
Before using the custom billing API, you need at least one billing Add-on installed and configured on your account. Add-ons can be set up at business level (shared across all sites) or site level (separate per site).
To let a customer add a payment method, redirect them to the custom billing checkout URL. Storeganise renders the payment provider's hosted UI, captures and tokenises the payment details, then redirects the customer back to your app.Render a link or redirect programmatically to:
The Storeganise site ID for the site the customer is registering a payment method for. When Add-ons are at business level only, this can be omitted. When multiple site-level Add-ons exist, passing an empty string aggregates across all of them.
returnUrl
Optional
The URL in your app the customer is sent to after checkout completes. Pass this to return the customer to the page where the checkout flow was initiated. Must be URL-encoded.
Once the customer completes the checkout flow, Storeganise redirects them to your returnUrl . The payment method is stored automatically — no further API call is needed to complete registration.
Example customer-facing checkout redirect flow
Step 2: List saved payment methods
To display a customer's stored payment methods in your app, call:
GET https://{yourcompany}.storeganise.com/api/v1/billing/custom/sources?siteId={siteId}
Parameter
Required
Description
siteId
No
Filter results to payment methods registered for a specific site. Pass a valid site ID to target one site's Add-on. Pass an empty string to aggregate across all configured Add-ons at site and business level. When omitted, Storeganise falls back to the business-level Add-on.
Note: Payment methods are scoped per Add-on. A customer who registers a payment method for one site will not see it when your app calls the API for a different site. Customers must register a payment method separately for each site they use.
Example request:
GET https://{yourcompany}.storeganise.com/api/v1/billing/custom/sources?siteId=site_xyz
Authorization: Bearer {userToken}
The exact fields returned vary by payment provider. All responses include an id. Most include masked card or account details — such as last4 and brand — suitable for display in your UI.
Customer billing section in a custom app showing saved cards for different sites
Once both endpoints are wired up, customers can add and manage their payment methods directly from your app, with Storeganise handling all tokenisation and storage in the background.
Jump to
Related articles
API FAQ
API best practices
How to replicate functionality in a custom booking flow