FreeBnk Pay API
The FreeBnk Pay API provides a comprehensive solution for managing cryptocurrency-based subscriptions, payment links, and recurring payments. Built for modern businesses accepting crypto payments, our API offers enterprise-grade features with simple integration.
4 subscribers
8.7/10 popularity
653 ms avg latency
80% success rate
14 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
FreeBnk Pay API endpoints
| Method | Endpoint | Description |
|---|---|---|
| Authentication | ||
| POST |
registerPartner /api/auth/register |
Create a new FreeBnk Pay account. This is the first step to start accepting crypto payments. After registration, you'll receive a JWT token to create your API keys. |
| POST |
createApiKey /api/webhooks/api-keys |
Generate a new API key for accessing payment endpoints. **Important**: Save the returned key immediately - it won't be shown again! |
| POST |
loginPartner /api/auth/login |
Authenticate with your email and password to receive access tokens. Use the returned token to create and manage API keys. |
| Subscriptions | ||
| GET |
getSubscription /api/partner/v1/subscriptions/{id} |
Retrieve detailed information about a specific subscription |
| PATCH |
suspendSubscription /api/partner/v1/subscriptions/{id}/suspend |
Temporarily suspend an active subscription. Billing is paused and the user loses access immediately. The subscription can be reactivated later. |
| GET |
listSubscriptions /api/partner/v1/subscriptions |
Retrieve a paginated list of all active subscriptions for your organization. Use filters to narrow down results by status, user, or date range. |
| POST |
reactivateSubscription /api/partner/v1/subscriptions/{id}/reactivate |
Reactivate a cancelled or suspended subscription. Billing resumes immediately and the user regains access. Only works if the subscription hasn't ended permanently. |
| POST |
cancelSubscription /api/partner/v1/subscriptions/{id}/cancel |
Cancel an active subscription. By default, the subscription remains active until the end of the current billing period. Use `cancelImmediately` to terminate access immediately. |
| Payments | ||
| GET |
listPayments /api/partner/v1/payments |
Retrieve a comprehensive list of all cryptocurrency payments received. Includes transaction details, blockchain confirmations, and settlement status. |
| GET |
getPaymentDetails /api/partner/v1/payments/{id} |
Get detailed information about a specific payment including blockchain transaction data, gas fees, and revenue split information. |
| Plans | ||
| GET |
listPlans /api/partner/v1/plans |
Retrieve all subscription plans created by your organization |
| POST |
createPlan /api/partner/v1/plans |
Create a new subscription plan with multi-chain cryptocurrency payment support. Configure pricing, features, trial periods, and blockchain networks. |
| PayLinks | ||
| POST |
createPayLink /api/partner/v1/paylinks |
Generate a payment link for one-time or recurring crypto payments. Configure amount, expiration, usage limits, and supported blockchain networks. |
| GET |
listPayLinks /api/partner/v1/paylinks |
Retrieve all payment links created by your organization. Includes statistics on usage and revenue generated. |
FreeBnk Pay API pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
| PRO Recommended | Free | 500 / minute |
|
