Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.axle.energy/llms.txt

Use this file to discover all available pages before exploring further.

Screenshot of payments portal We use Stripe as our payment provider, leveraging their Global Payouts functionality. We provide you with a page where your users can:
  1. View their rewards balance
  2. Link a UK bank account
  3. Withdraw earned rewards to their bank
The URL for this page is generated via our API and secured with a JWT token. Availability: UK only (GB bank accounts, GBP currency)

​
Requirements

A user email is required to process payments through our provider, Stripe. We also send payment-failure notifications and, if enabled, two-factor authentication codes to this address. The right place to supply the email depends on how you’re integrated with us — check the integration guide for the product you’re using (Smart Charging, Flex Lite, VPP, etc.) for the field to set when you create or onboard the user.

​
High-level flow

​
Environments

EnvironmentPayments PortalAPIUse Case
Sandboxpayment-sandbox.axle.energyapi-sandbox.axle.energyDevelopment and testing
Productionpayments.axle.energyapi.axle.energyLive users
Use the Sandbox environment for all development and testing. When you’re ready to go live, switch to Production.

​
Security considerations

  • JWT tokens expire after 60 minutes (payment failure emails use 48-hour tokens)
  • Two-factor authentication can be enforced via the enforce_two_factor_auth parameter (email verification only)
  • Bank account details are validated via Confirmation of Payee (CoP) before any withdrawal is processed
  • Users must re-authenticate for each session

​
Support

For integration support, contact: support@axle.energy