Getting Started

Introduction

Introduction

The Recurrente API lets you create checkout sessions, manage your products, subscriptions, and customers, transfer money between different Recurrente accounts, and much more.

Getting Started

  • Create an account on Recurrente.
  • The API responds in JSON format. When it returns an error, the error is sent in an error key in JSON.

Base URL

https://app.recurrente.com/api

Quick Start

  1. Get your API keys from the Recurrente dashboard under Settings → API Keys
  2. Test your credentials with a simple GET request:
$curl https://app.recurrente.com/api/test \
>  -H "X-PUBLIC-KEY: your_public_key" \
>  -H "X-SECRET-KEY: your_secret_key"
  1. Create your first checkout:
$curl -X POST https://app.recurrente.com/api/checkouts \
>  -H "X-PUBLIC-KEY: your_public_key" \
>  -H "Content-Type: application/json" \
>  -d '{
>    "items": [{
>      "name": "T-Shirt",
>      "amount_in_cents": 15000,
>      "currency": "GTQ",
>      "quantity": 1
>    }],
>    "success_url": "https://yoursite.com/success",
>    "cancel_url": "https://yoursite.com/cancel"
>  }'

This returns a checkout_url — redirect your customer there to complete the payment.

What can you do with the API?

FeatureDescription
CheckoutsCreate hosted payment pages
ProductsManage your catalog and pricing
SubscriptionsHandle recurring billing
CustomersTrack and manage your buyers
RefundsProcess refunds on payments
TransfersSend money between accounts
WebhooksGet notified about events

Sandbox and Test Payments

There are two ways to perform tests: using the Sandbox environment or testing directly in production, depending on the type of validation you need.

✅ Sandbox Environment

The Sandbox environment allows test payments without generating real activity. To use it:

  • Use your TEST environment keys.
  • Simulate a successful payment with the card 4242 4242 4242 4242.

Checkouts created with TEST keys:

  • Show a notice saying “TEST” on the payment link.
  • Have the attribute live_mode = false.
  • Do not create account activity or affect the balance.
  • Do not trigger webhooks.

This environment is ideal for testing during initial integration or development.

⚠️ Production Testing

It’s also possible to perform tests in LIVE environment with your production keys. In these cases:

  • It’s recommended to refund test payments the same day, either from the Recurrente panel or via the API at /api/refunds.
  • Payments refunded the same day are refunded at 100% of the amount.

This option allows you to validate the complete flow, including account activity, webhooks, and reconciliation.

Need help?