Inqud Docs
  • Developer
    • 🟢Inqud API
    • 🔑Authentication
    • 🪝Web Hooks
      • Web Hook Verification
      • Payment Web Hook
    • Payment Statuses
    • 📃API Reference
  • Payments
    • 🔢Payment Methods
    • 💸Withdrawal/Payout
      • Cross Payout Feature
    • 💰Deposit/Payin
    • 💰H2H Deposit/Payin
  • Crypto Widget
    • 💣Integration overview
    • Usage models
    • Extra features
      • Auto-conversion
      • Preselected currency checkout
    • 💱Coverage
    • 📄Glossary
    • ✅Get started
      • Onboarding
      • Setup instructions
    • 🔎Explore
      • Checkouts
      • Requests
      • Payments
    • 💻Integration
      • ⚙️Redirect payment flow
      • ⚙️Embedded widget
      • ⚙️Using your own UI with Inqud processing
      • 🪝Web Hooks
        • Checkout Web Hook
        • Request Web Hook
      • 📃API Reference
  • Crypto Static Addresses
    • 📃Overview
    • 💱Coverage
    • ✅Get Started
      • 1️⃣Step 1. Account verification
      • 2️⃣Step 2. Project setup
      • 3️⃣Step 3. Integration
    • 💻Integration
      • ⚙️API Integration
      • 🪝Web Hooks
      • 📃API Reference
  • Crypto Recurring
    • 📃Overview
      • Inqud Hosted Page overview
      • Inqud Recurring SDK overview
    • 💡Use Cases
      • Subscription Payments
      • On-Demand Payments
    • 💱Coverage
    • 📄Glossary
    • ✅Get Started
      • 1️⃣Step 1. Account verification
      • 2️⃣Step 2. Project setup
      • 3️⃣Step 3. Plan setup
      • 4️⃣Step 4. Integration
    • 🔎Explore
      • How it works
      • Project
      • Plan
      • Authorization
      • Subscription
      • Invoice
      • Payment Intent
    • 💻Integration
      • ⚙️Inqud Hosted
      • ⚙️Recurring SDK
        • SDK Package & Docs
        • SDK Usage Example
        • Example Sandbox
      • 🪝Web Hooks
        • Subscription Web Hook
        • Authorization Web Hook
        • Invoice Web Hook
      • 📃API Reference
Powered by GitBook
On this page
  • Prerequisites
  • Plan link
  • Subscription plan integration
  • On demand plan integration
  1. Crypto Recurring
  2. Integration

Inqud Hosted

PreviousIntegrationNextRecurring SDK

Last updated 10 months ago

Users can be directed from your website or mobile application to the Inqud Hosted Page to complete subscription process.

Prerequisites

  • Your business account with Inqud is set up, complete with API tokens configured.

  • The Crypto Recurring Project has been established and configured within the Inqud platform.

  • Plans are created within project.

If you don't have the prerequisites in place yet, please refer to the following page:

There are two types of recurring plans: On-demand and Subscription. The integration method is different for each type, ensuring that the specific needs of each plan are met efficiently.

For details about the different plan types, please refer to the following page:

Plan link

This step applies to both subscription and on-demand plans.

Once you have created a plan, you can share a link with the end user you want to subscribe. Each plan has a unique plan ID in the following format:

PLAN-195cd70d-4d82-41d6-90aa-897c28126ddf

To create a link with this plan ID, use the following format:

https://recurring.inqud.com/plans/{planId}

For example, using the plan ID PLAN-195cd70d-4d82-41d6-90aa-897c28126ddf, the link would be:

https://recurring.inqud.com/plans/PLAN-195cd70d-4d82-41d6-90aa-897c28126ddf

Optionally, you can pass an orderId within the plan link to later distinguish between subscriptions and authorizations.

To create a link with this plan ID and order ID , use the following format:

https://recurring.inqud.com/plans/{planId}?orderId={orderId}

For example, using the plan ID PLAN-195cd70d-4d82-41d6-90aa-897c28126ddf and order ID order28126, the link would be:

https://recurring.inqud.com/plans/PLAN-195cd70d-4d82-41d6-90aa-897c28126ddf?orderId=order28126

You can share this link with your end user to allow them to subscribe to the plan directly.

Subscription plan integration

You can use "hourly" subscription plans for testing purposes

After sharing the plan link with the user and they subscribe, you will begin receiving Subscription webhook notifications. If you included an orderId in the plan link, the created Subscription will have this ID specified. Webhooks are triggered by any change in subscription status, so ensure you handle all subscription statuses appropriately. Subscription webhook details:

The Subscription object and its status provide all the information you need to integrate with Inqud Recurring Subscription. Inqud will handle all recurring charge processing for you.

On demand plan integration

After sharing the plan link with the user and they authorize spending, an Authorization object is created. You can receive webhook notifications for new Authorizations. If you included an orderId in the plan link, the created Authorization object will have this ID specified. Webhooks are triggered by any change in authorization status, so ensure you handle all authorization statuses appropriately.

Authorization webhook details:

Invoice webhook details:

You can check the current transferable authorization balance via the Inqud API: Once you have an authorization with the status 'GRANTED,' you can create Invoice to charge the user via the Inqud API: As invoices are processed asynchronously, you can track their status either by polling the API or by receiving invoice notifications through Webhooks.

💻
⚙️
✅Get Started
Plan
Subscription Web Hook
Authorization Web Hook
Authorizations API
Invoices API
Invoice Web Hook