Recurring Payments API
The Recurring Payments API lets you create and manage subscription plans, customers, payment methods, subscriptions, and charges.
Use a merchant JWT on every request. The token already identifies your merchant; creates and lists are scoped to that merchant automatically.
Sections
- Plans — Create and manage subscription plans (
subscription_urlfor checkout) - Customers — Create, list, get, update, and delete customers
- Payment methods — Create and manage cards on file
- Subscriptions — Create, list, get, update, cancel, and bulk-update
- Charges — List charges and get attempt history
- Checkout — Hosted subscription flow (
subscription_url) and customer portal - Webhooks — Event catalog and Platform Webhooks integration
Authentication
All requests require a JWT in the Authorization header.
The token identifies tenant and merchant. Creates and lists are scoped to that merchant automatically.
merchant_id in JSON responses and webhooks is the merchant UUID (internal id). merchant_code on plans matches the merchant identifier in the token.
- API Key: Authorization
JWT from the authentication flow. The merchant in the token scopes every operation.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | authorization |
The login flow to obtain this JWT will be provided in due course. Contact Geopagos if you need credentials for a sandbox or integration environment.
Webhooks
Recurring Payments emits events when subscriptions, charges, or plans change. Register listeners in Platform Webhooks and handle the JSON data payload (includes event_type).