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
  • What is an Authorization?
  • Authorization parameters
  • Authorization balance
  • Authorization statuses
  • Authorization status transitions
  1. Crypto Recurring
  2. Explore

Authorization

The Authorization page of the Inqud Crypto Recurring allows you to view user-approved spending agreements for your plans. An authorization represents the user's agreement to be charged based on the plan's conditions and involves an actual ERC-20 approval transaction made by the user using their Web3 wallet.

What is an Authorization?

An authorization is a user-approved spending agreement for a specific plan. It signifies the user's consent to be charged according to the plan's conditions. This process includes an ERC-20 token approval transaction performed by the user via their Web3 wallet, ensuring secure and verifiable permissions for recurring payments.

An authorization is created when a user subscribes to a plan.

Authorization parameters

Parameter name
Description
Value (example)

id

ID of authorization.

"AGR-55502ab7-d322-465e-b856-51f0ca077dd2"

wallet

Wallet used by user to subscribe.

0x364371e1fbe635922b0f37d569f8d0e12b122822

cryptoCurrency

Blockchain and token approved by user for spending.

"ETHEREUM_USDT"

status

Authorization status.

GRANTED, REVOKED_BY_MERCHANT

subscriptionId

ID of subscription associated with authorization.

"SUB-df39a8ab-0bbc-464c-acae-c0ce265a4713"

initApprovalTx

Transaction hash were user approved tokens spending.

"0xbd01120e922a778cc2047cf089b4772b0323587eaea4996b6572dedb67f6e52a"

planId

ID of plan associated with authorization.

"PLAN-d5208959-5ced-41c7-9d9e-31923b6a22a6"

Authorization balance

By clicking on an authorization record, a user can see real-time balance details of the given authorization. This includes:

Parameter name
Description
Value (example)

balance

The current balance of the user's account associated with the authorization.

1000

allowance

The total amount approved for spending under this authorization.

500

transferable

The remaining amount that can be transferred based on the authorization

500

Authorization statuses

  • GRANTED: The authorization is active, allowing payments to be processed according to the specified plan conditions.

  • REVOKED_BY_MERCHANT: The authorization has been canceled by the merchant, and no further payments will be processed.

Authorization status transitions

PreviousPlanNextSubscription

Last updated 10 months ago

🔎
Drawing