API reference

सशुल्क लिंक से API

MakePay भुगतान लिंक बनाएं, सूचीबद्ध करें, निरीक्षण करें, रोकें, संग्रहीत करें और भेजें।

मार्गों

MakeCrypto से होस्ट किए गए MakePay भुगतान लिंक बनाने और प्रबंधित करने के लिए इन मार्गों का उपयोग करें।

Method	Route
GET	`/api/partner/v1/companies`
Auth session Use User companies list करें authenticated MakeCrypto user के portal tools के लिए उपलब्ध teams लौटाता है.
POST	`/api/partner/v1/onboarding/company`
Auth partner onboarding secret Use Company onboarding link बनाएं partner द्वारा prefilled onboarding draft बनाता है और merchant claim URL लौटाता है.
GET	`/api/partner/v1/makepay/payment-links`
Auth MakePay API key Use Payment links list करें या बनाएं API key की company के payment links पढ़ता है या hosted MakePay checkout links बनाता है.
POST	`/api/partner/v1/makepay/payment-links`
Auth MakePay API key या public Use Payment links list करें या बनाएं API key की company के payment links पढ़ता है या hosted MakePay checkout links बनाता है.
POST	`/gateway/pay/{makepayKeyId}`
Auth public form key Use HTML payment form submit करें browser form fields स्वीकार करता है, hosted payment link बनाता है, और shopper को checkout पर redirect करता है.
GET	`/api/partner/v1/makepay/payment-links/{uid}`
Auth MakePay API key Use Payment link लें या update करें payment link detail पढ़ता है या उसकी state को active, paused, या archived में बदलता है.
PATCH	`/api/partner/v1/makepay/payment-links/{uid}`
Auth MakePay API key Use Payment link लें या update करें payment link detail पढ़ता है या उसकी state को active, paused, या archived में बदलता है.
POST	`/api/partner/v1/makepay/payment-links/{uid}/send-request-email`
Auth MakePay API key Use Payment request भेजें hosted link customer email पर भेजता या फिर से भेजता है.
GET	`/api/partner/v1/makepay/subscriptions`
Auth MakePay API key Use Subscriptions list करें या बनाएं recurring MakePay subscription plans लौटाता है या subscription और पहली invoice बनाता है.
POST	`/api/partner/v1/makepay/subscriptions`
Auth MakePay API key Use Subscriptions list करें या बनाएं recurring MakePay subscription plans लौटाता है या subscription और पहली invoice बनाता है.
GET	`/api/partner/v1/makepay/customers`
Auth MakePay API key Use Customers list करें या update करें MakePay customer profiles लौटाता है या email द्वारा customers create/update करता है.
POST	`/api/partner/v1/makepay/customers`
Auth MakePay API key Use Customers list करें या update करें MakePay customer profiles लौटाता है या email द्वारा customers create/update करता है.
POST	`/api/partner/v1/makepay/customers/{customerId}/portal`
Auth MakePay API key Use Customer portal link बनाएं 24 घंटे के लिए valid signed MakePay customer portal URL on demand generate करता है.
GET	`/api/partner/v1/timezones`
Auth public Use Timezones list करें supported IANA timezone identifiers लौटाता है.
GET	`/api/partner/v1/makepay/settings`
Auth MakePay API key Use MakePay settings पढ़ें या update करें settlement, redirects, fees, और underpayment handling settings पढ़ता या update करता है.
PUT	`/api/partner/v1/makepay/settings`
Auth MakePay API key Use MakePay settings पढ़ें या update करें settlement, redirects, fees, और underpayment handling settings पढ़ता या update करता है.
GET	`/api/partner/v1/makepay/destination-assets`
Auth MakePay API key Use Destination assets list करें supported settlement assets और current default asset लौटाता है.
GET	`/api/partner/v1/makepay/webhook-requests`
Auth MakePay API key Use Webhook deliveries list करें payment और subscription webhook delivery attempts और retry status दिखाता है.

एक भुगतान लिंक बनाएं

निर्माण मार्ग एक MakePay भुगतान लिंक सम्मिलित करता है, व्यापारी ब्रांडिंग और निपटान डिफ़ॉल्ट को हल करता है, रनटाइम बिलिंग फ़ील्ड इंजेक्ट करता है, और सार्वजनिक checkout URL लौटाता है।

POST /api/partner/v1/makepay/payment-links

json

{
  "status": "active",
  "sendPaymentRequestEmail": false,
  "payload": {
    "title": "Website order #1042",
    "description": "Checkout for order #1042",
    "amount": "129.99",
    "fiatCurrency": "USD",
    "currency": "USDT",
    "orderId": "order_1042",
    "customerEmail": "buyer@example.com",
    "returnUrl": "https://merchant.example/orders/1042",
    "successUrl": "https://merchant.example/orders/1042/success",
    "failureUrl": "https://merchant.example/orders/1042/failure",
    "expirationTime": "12h",
    "metadata": {
      "cartId": "cart_7M2V",
      "source": "api"
    }
  }
}

बिना कोड वाले या कम कोड वाले ब्राउज़र checkout बटन के लिए, फॉर्म सबमिट भुगतान देखें। यह एक सादा HTML POST स्वीकार करता है, उसी तरह का होस्टेड भुगतान लिंक बनाता है, और खरीदार को MakePay checkout पर रीडायरेक्ट करता है।

आवश्यक सेटअप

कंपनी के पास MakePay डिफ़ॉल्ट गंतव्य संपत्ति होनी चाहिए। यदि निपटान कॉन्फ़िगर नहीं किया गया है, तो रूट errorCode: "onboarding_required" के साथ 409 लौटाता है।

राशि और परिसंपत्ति फ़ील्ड

ग्राहक-सामना वाली राशि के लिए payload.amount का उपयोग करें। सटीक गंतव्य संपत्ति के लिए या तो payload.asset पास करें या जब कंपनी की डिफ़ॉल्ट गंतव्य संपत्ति श्रृंखला को हल कर सकती है तो payload.currency पास करें। यदि एक मुद्रा कई श्रृंखलाओं पर सक्षम है और कोई मेल खाने वाली कंपनी डिफ़ॉल्ट मौजूद नहीं है, तो स्पष्ट रूप से payload.asset पास करें।

समय सीमा समाप्ति

payload.expirationTime 15m, 1h, 12h, 24h, 72h, या never स्वीकार करता है। API भुगतान लिंक पर हल किए गए expires_at टाइमस्टैम्प को संग्रहीत करता है।

प्रतिक्रिया बनाएँ

json

{
  "ok": true,
  "paymentRequestEmailSent": false,
  "paymentRequestEmailError": null,
  "paymentLink": {
    "id": "8d15bb78-d0f8-45ef-88d7-2a1f1f79644b",
    "uid": "01hzy4k6p4w9y2x7e2z7n8a2xm",
    "status": "active",
    "expires_at": "2026-04-19T12:00:00.000Z",
    "created_at": "2026-04-19T00:00:00.000Z",
    "updated_at": "2026-04-19T00:00:00.000Z",
    "publicUrl": "https://makepay.io/payment/01hzy4k6p4w9y2x7e2z7n8a2xm",
    "payload": {
      "title": "Website order #1042",
      "description": "Checkout for order #1042",
      "amount": "129.99",
      "fiatCurrency": "USD",
      "currency": "USDT",
      "orderId": "order_1042",
      "customerEmail": "buyer@example.com",
      "returnUrl": "https://merchant.example/orders/1042",
      "successUrl": "https://merchant.example/orders/1042/success",
      "failureUrl": "https://merchant.example/orders/1042/failure",
      "expirationTime": "12h",
      "metadata": {
        "cartId": "cart_7M2V",
        "source": "api"
      },
      "asset": "ETH.USDT-0xdac17f958d2ee523a2206206994597c13d831ec7",
      "runtimeMode": "merchant_target_net_v2",
      "billingVersion": "v2",
      "merchantName": "Merchant Co",
      "merchantPaymentLinkTheme": "system"
    }
  }
}

भुगतान लिंक सूचीबद्ध करें

बैक-ऑफ़िस समाधान, डैशबोर्ड और धूम्रपान परीक्षण के लिए सूची मार्ग का उपयोग करें।

curl

curl "https://www.makecrypto.io/api/partner/v1/makepay/payment-links" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

भुगतान-लिंक विवरण प्राप्त करें

जब आपके पास पहले से ही भुगतान-लिंक UID है और आपको सामान्यीकृत लिंक, सार्वजनिक checkout URL, नवीनतम भुगतान सत्र और टाइमलाइन ईवेंट की आवश्यकता है, तो विवरण मार्ग का उपयोग करें।

curl

curl "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

भुगतान लिंक को रोकें या संग्रहीत करें

किसी लिंक को भुगतान होने से रोकने या सक्रिय संचालन से छिपाने के लिए स्टेटस रूट का उपयोग करें।

curl

curl -X PATCH "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"status":"paused"}'

status को active, paused, या archived होना चाहिए।

भुगतान अनुरोध ईमेल भेजें

MakeCrypto होस्टेड लिंक को सीधे भुगतान-लिंक पेलोड पर ग्राहक ईमेल पर या अनुरोध निकाय में ओवरराइड ईमेल पर भेज सकता है।

curl

curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID/send-request-email" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"email":"buyer@example.com"}'

केवल सक्रिय भुगतान लिंक ही ईमेल किए जा सकते हैं। पूर्ण भुगतान लिंक दोबारा नहीं भेजे जा सकते।