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
  1. Payments

Deposit/Payin

PreviousCross Payout FeatureNextH2H Deposit/Payin

Last updated 14 days ago

The payin operation involves depositing funds into an account from various sources such as cards or crypto wallets.

Supported Payin Methods

  • Card Deposit funds from a credit or debit card..

  • Crypto Wallet Deposit funds from a cryptocurrency wallet.

Payin Flow

  1. Initiate Payin: Submit with the chosen method.

  2. Validation: The system verifies the provided payment details (card number or wallet address).

  3. Redirect User: User should be redirected to page from payUrl field to complete payment.

  4. Processing: The deposit is processed and credited to the user's account.

  5. Notification: If webhook settings specified, webhook is sent for each . Webhook body represents . Please refer to to get more details.

If no webhook settings specified, you can retrieve payment status via

Example API Request (See the API reference for more examples)

{
    "amount": 100,
    "clientOrderId": "1234567890",
    "currency": "EUR",
    "firstName": "John",
    "lastName": "Doe",
    "method": "CC_VISAMC",
    "returnUrl": "https://example.com/"
}

Example API Request using prefetched payment method id

  1. Fetch payment methods, e.g. to perform crypto BITCOIN/BTC/PAYIN:

    
    [
      {
        "blockchain": "BITCOIN",
        "currency": "BTC",
        "fixed": 0.0001,
        "hasNetworkFee": true,
        "id": "PMD-2eb51bd4-6117-437b-b933-502538a9662a",
        "maxLimit": 10,
        "methodKey": "CRYPTOCOIN",
        "minFeeAmount": 1,
        "minFeeCurrency": "EUR",
        "minLimit": 0.0001,
        "name": "bitcoin payin",
        "orderType": "PAYIN",
        "percent": 0.1,
        "productType": "PAYMENT",
        "properties": {
          "optional": [
            "email"
          ],
          "required": [
            "firstName",
            "lastName"
          ]
        },
        "scale": 6,
        "verificationLevel": 3
      }
    ]
  2. Perform proper payout call

    {
        "paymentMethodId": "PMD-2eb51bd4-6117-437b-b933-502538a9662a",
        "amount": 0.1,
        "firstName": "John",
        "lastName": "Doe"
    }

Example API Response

{
  "amount": 100,
  "clientOrderId": "1234567890",
  "createdAt": "2022-12-01T12:00:00Z",
  "currency": "EUR",
  "externalId": "c2544dd6e1c53529b877682127d16cff524f2867a57c5cc204e42eb2573e02e0",
  "id": "PMT-b2e2df8c-281a-4cc1-2bcf-61b803358f0e",
  "method": "CC_VISAMC",
  "orderId": "ORD-b40c5710-c419-432b-9814-bac03cb4fe1c",
  "orderType": "PAYIN",
  "payUrl": "https://hpp.inqud.com/PMT-b2e2df8c-281a-4cc1-2bcf-61b803358f0e",
  "status": "NEW",
  "transactionType": "DEBIT"
}
💰
a deposit request
status transition
payment model
webhook section
GET endpoint