Welcome to the Recurpay API documentation, designed to transform the subscriptions process for businesses across the globe. The APIs provided by Recurpay offer a range of use cases to enhance efficiency and customer satisfaction. These APIs enable you to retrieve essential information, monitor transaction status, and make data-driven decisions.

Getting Started

There are 2 ways primarily you can start building on Recurpay:

• 📢 Public App: If you are looking to build an integration for all merchants using Recurpay, we will recommend you to build a public app which will be available to all merchants under their Integration section of Recurpay dashboard as soon as your app is approved.

📘

Public apps require approval from Recurpay.

You can start building integrations immediately with public app, however, merchants will only be able to use the app post approval on their store. The approval process usually take 4-6 weeks after submission and may vary depending on the ongoing queue of builders.

• 🔒 Custom app: If you are building an integration specific to a store/merchant or for a specific use case like sending data to a customer CRM/CMS/ERP etc., you should use the custom app option available on the merchant's Recurpay dashboard.

📘

Custom apps does not require any approval from Recurpay.

You can start building integrations immediately with custom apps for any specific store.

How public app integration works with Recurpay ?

Public app as the name suggests is a type of app integration available to all merchants publicly. Once the app is approved by Recurpay, merchants can activate/deactivate them immediately from their Recurpay dashboard.

Building a public app integration with Recurpay happens in few easy steps:

1. Register as partner with Recurpay - Fill a simple form with basic details about your application.
2. Recurpay team will review and analyse the integration benefits for merchants
3. Recurpay team will send the app credentials over email provided during registration once the app is approved.
4. Install Recurpay on any of your Shopify store for development. Reach out to us at [email protected] and share your store URL so we can activate the app for testing.
5. As soon as any store activates your app, Recurpay will send the store ID on the callback URL provided in Step 1. The format of the request body will be like this:

When a store activates your app:

{
  "store_id": 26000,
  "store_name": "Store name",
  "store_url": "https://their-store.recurpay.com",
  "scope": "read-subscriptions",
  "active": true,
  "associated_user": {
    "id": 15000,
    "first_name": "Tony",
    "last_name": "Stark",
    "email": "[email protected]",
    "email_verified": true,
    "account_owner": true
  }
}

When a store deactivates your app:

{
  "store_id": 26000,
  "store_name": "Store name",
  "store_url": "https://their-store.recurpay.com",
  "active": false,
  "associated_user": {
    "id": 15000,
    "first_name": "Tony",
    "last_name": "Stark",
    "email": "[email protected]",
    "email_verified": true,
    "account_owner": true
  }
}

6. Use the store_id sent by Recurpay to fetch the access token for that store using our GET Access Token API.
7. Register for webhooks of the store using Register webhook API
8. Start receiving data for the store
9. Once you are done with development, let us know by dropping a mail at [email protected] and we will review the app functioning.
10. Recurpay will approve your app and it will be available to all merchants on their Recurpay dashboard.
11. Recurpay will send the store details (Store id will be sent on callback URL) as and when they activate your app on their store. Once received, repeat step 7.

📘

We recommend using our APIs as well for backup to webhooks.

Use scheduled sync with the Recurpay data. To pull any missed information during webhook transfer

How custom app integration works with Recurpay?

Custom app as the name suggests is a type of app integration used to build only for a specific merchant

You can build a custom app for any merchant in few easy steps:1

1. Log on to merchant's Recurpay dashboard
2. Go to Settings > Integrations > Develop apps

3. Click on create new app option

4. Enter the required details and create the app.

5. Add the scopes as required

   

6. Use the credentials to register webhook or make API calls.

📘

Feel free to reach out to us

Via Live chat or write us at [email protected] if you need any help anytime.

Few ideas to get started and build something powerful, together!

• Send real-time notifications to customers via Whatsapp, SMS, Telegram or even your choice of email service providers.
• Send data to your own systems for reconcillation after every subscriptions activity.
• Automate order identification based on condition
• Build custom analaytics and reporting system to get deeper insights of your customer behaviour.

💬 We're here to help!

If you get stuck, shoot us an email or use the Intercom widget on the bottom right of any page.

We're excited you're here! 💙