API reference

संदर्भ

रूट, ऑब्जेक्ट मॉडल, एनम, कॉन्फ़िगरेशन और त्रुटि स्वरूपण।

मार्ग संदर्भ

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 दिखाता है.

OAuth पर भागीदार

POST /api/partner/v1/onboarding/company में एक वैकल्पिक oauth ऑब्जेक्ट शामिल हो सकता है। MakeCrypto ऑनबोर्डिंग लिंक बनाने से पहले OAuth ऐप को मान्य करता है, URI, स्कोप और PKCE चुनौती को रीडायरेक्ट करता है। जब व्यापारी ऑनबोर्डिंग पूरा कर लेता है, तो MakeCrypto कंपनी बनाता है, OAuth ऐप को उस कंपनी तक पहुंच प्रदान करता है, और प्राधिकरण code के साथ पंजीकृत redirectUri पर रीडायरेक्ट करता है।

{
  "idempotencyKey": "merchant_123",
  "company": {
    "name": "Acme Markets",
    "website": "https://acme.example"
  },
  "oauth": {
    "clientId": "mco_app_example",
    "redirectUri": "https://apps.makecrypto.io/oauth/callback",
    "scope": "company:read makepay:payment-links:write makepay:settings:read",
    "state": "merchant_123",
    "codeChallenge": "PKCE_S256_CODE_CHALLENGE",
    "codeChallengeMethod": "S256"
  }
}

पार्टनर ऐप को मैचिंग PKCE code_verifier रखना चाहिए और लौटाए गए कोड को POST /oauth/token के माध्यम से एक्सचेंज करना चाहिए।

PaymentLink ऑब्जेक्ट

फ़ील्ड	प्रकार	नोट्स
`id`	`string`	आंतरिक UUID.
`uid`	`string`	सार्वजनिक भुगतान-लिंक पहचानकर्ता का उपयोग होस्ट किए गए और एम्बेडेड checkout मार्गों में किया जाता है।
`status`	`"active" \| "paused" \| "archived"`	व्यापारी-प्रबंधित लिंक स्थिति.
`payload`	`PaymentLinkPayload`	व्यापारी का ऑर्डर, राशि, ग्राहक, रीडायरेक्ट, मेटाडेटा, ब्रांडिंग और रनटाइम फ़ील्ड।
`created_at`	`string`	आईएसओ टाइमस्टैम्प.
`updated_at`	`string`	आईएसओ टाइमस्टैम्प.
`expires_at`	`string \| null`	समाप्ति समय-स्टैम्प का समाधान, या बिना समाप्ति के `null`।
`publicUrl`	`string`	होस्ट किया गया MakePay checkout URL, निर्माण, सूची, विवरण और स्थिति अद्यतन प्रतिक्रियाओं में शामिल है।

PaymentLinkPayload

फ़ील्ड	प्रकार	नोट्स
`title`	`string`	भुगतान के लिए लेबल प्रदर्शित करें.
`description`	`string`	Customer-सामना करने वाला विवरण।
`amount`	`string`	एकत्रित करने के लिए दशमलव राशि.
`fiatCurrency`	`string`	वैकल्पिक प्रदर्शन मुद्रा जैसे `USD` या `EUR`।
`currency`	`string`	निपटान प्रतीक जैसे `USDT`, `USDC`, या `BTC`।
`asset`	`string`	सटीक गंतव्य संपत्ति पहचानकर्ता. इसका उपयोग तब करें जब एक प्रतीक एकाधिक श्रृंखलाओं पर मौजूद हो।
`orderId`	`string`	व्यापारी आदेश या चालान संदर्भ.
`customerEmail`	`string`	ईमेल अनुरोधों और webhook पेलोड के लिए उपयोग किया जाता है।
`clientId`	`string`	वैकल्पिक व्यापारी-पक्ष ग्राहक पहचानकर्ता.
`returnUrl`	`string`	सामान्य रिटर्न नेविगेशन के लिए व्यापारी URL।
`successUrl`	`string`	पूर्ण भुगतान के लिए व्यापारी URL।
`failureUrl`	`string`	विफल या रद्द भुगतान के लिए व्यापारी URL।
`expirationTime`	`"15m" \| "1h" \| "12h" \| "24h" \| "72h" \| "never"`	अनुरोधित भुगतान-लिंक जीवनकाल।
`metadata`	`Record<string, unknown>`	व्यापारी द्वारा परिभाषित मेटाडेटा डैशबोर्ड और webhooks में लौटाया गया।
`runtimeMode`	`"merchant_target_net_v2"`	नए भुगतान लिंक के लिए API द्वारा इंजेक्ट किया गया।
`billingVersion`	`"v2"`	नए भुगतान लिंक के लिए API द्वारा इंजेक्ट किया गया।
`merchantName`	`string`	उपलब्ध होने पर कंपनी ब्रांडिंग से इंजेक्शन लगाया जाता है।
`merchantPictureUrl`	`string`	उपलब्ध होने पर कंपनी प्रोफाइल से इंजेक्ट किया गया।
`merchantLogoUrl`	`string`	उपलब्ध होने पर व्यापारी ब्रांडिंग से इंजेक्ट किया गया।
`merchantPaymentLinkTheme`	`"light" \| "dark" \| "system"`	व्यापारी checkout थीम सेटिंग्स से इंजेक्ट किया गया।

Customer ऑब्जेक्ट

फ़ील्ड	प्रकार	नोट्स
`id`	`string`	आंतरिक UUID.
`uid`	`string`	सार्वजनिक MakePay ग्राहक पहचानकर्ता का उपयोग पोर्टल लिंक में किया जाता है।
`email`	`string`	Customer ईमेल।
`name`	`string \| null`	Customer प्रदर्शन नाम. ग्राहक पोर्टल से संपादन योग्य.
`clientId`	`string \| null`	व्यापारी-पक्ष ग्राहक पहचानकर्ता. पोर्टल में केवल पढ़ने के लिए।
`metadata`	`Record<string, unknown>`	व्यापारी-परिभाषित मेटाडेटा.
`createdAt`	`string`	आईएसओ टाइमस्टैम्प.
`updatedAt`	`string`	आईएसओ टाइमस्टैम्प.
`urls`	`{ customerPortal: string }`	पोर्टल जनरेशन प्रतिक्रियाएँ प्रस्तुत करें। इस URL को जारी न रखें।

Customer पोर्टल प्रतिक्रिया

POST /api/partner/v1/makepay/customers/{customerId}/portal संग्रहीत ग्राहक के लिए एक हस्ताक्षरित पोर्टल URL लौटाता है।

json

{
  "ok": true,
  "companyId": "acct_123",
  "customer": {
    "id": "b834dd77-69b8-41a9-a4b6-95bc9dd14c2d",
    "uid": "cus_01hzy4k6p4w9y2x7e2z7n8a2xm",
    "email": "buyer@example.com",
    "name": "Ada Lovelace",
    "clientId": "client_1042",
    "metadata": {
      "source": "api"
    },
    "createdAt": "2026-04-20T10:00:00.000Z",
    "updatedAt": "2026-04-20T10:00:00.000Z",
    "urls": {
      "customerPortal": "https://makepay.io/billing?company=acct_123&customer=cus_01hzy4k6p4w9y2x7e2z7n8a2xm&expires=1776765600&signature=8d1f..."
    }
  },
  "expiresAt": "2026-04-21T10:00:00.000Z"
}

URL 24 घंटे के लिए वैध है और उपलब्ध होने पर कंपनी के सत्यापित payment_link_domain का उपयोग करता है। अन्यथा यह वापस MakePay सार्वजनिक मूल पर आ जाता है।

क्वेरी पैरामीटर	नोट्स
`company`	MakeCrypto कंपनी खाता आईडी जो ग्राहक का स्वामी है।
`customer`	MakePay ग्राहक UID।
`expires`	सेकंड में यूनिक्स टाइमस्टैम्प।
`signature`	`v1:{companyId}:{customerUid}:{expires}` पर HMAC हस्ताक्षर।

जब ग्राहक बिलिंग खोले तो मांग पर पोर्टल लिंक जेनरेट करें। पोर्टल डेटा लोड होने से पहले समाप्त हो चुके, छेड़छाड़ किए गए, या क्रॉस-ग्राहक URLs को अस्वीकार कर दिया जाता है।

Subscription ऑब्जेक्ट

फ़ील्ड	प्रकार	नोट्स
`id`	`string`	आंतरिक UUID.
`uid`	`string`	व्यापारी-सामना सदस्यता पहचानकर्ता.
`status`	`"active" \| "paused" \| "overdue" \| "cancelled"`	वर्तमान सदस्यता स्थिति.
`customerEmail`	`string`	Customer ईमेल का उपयोग अनुस्मारक और पोर्टल मिलान के लिए किया जाता है।
`label`	`string`	Customer-सामना वाला सदस्यता लेबल।
`description`	`string \| null`	वैकल्पिक सदस्यता विवरण.
`amountUsd`	`string`	आवर्ती USD राशि.
`settlementAsset`	`string`	गंतव्य निपटान परिसंपत्ति पहचानकर्ता.
`cadence`	`"weekly" \| "biweekly" \| "monthly" \| "custom_months" \| "yearly"`	ताल प्रदर्शित करें.
`billingIntervalUnit`	`"week" \| "month" \| "year"`	बिलिंग अंतराल इकाई.
`billingIntervalCount`	`number`	बिलिंग चक्रों के बीच इकाइयों की संख्या.
`startAt`	`string`	पहले बिलिंग चक्र के लिए आईएसओ टाइमस्टैम्प।
`timezone`	`string`	IANA समयक्षेत्र अनुस्मारक समय के लिए उपयोग किया जाता है।
`metadata`	`Record<string, unknown>`	व्यापारी-परिभाषित मेटाडेटा और उन्नत रीडायरेक्ट/सहिष्णुता सेटिंग्स।
`cycles`	`SubscriptionCycle[]`	उत्पन्न बिलिंग चक्र सूची मार्गों और डैशबोर्ड कॉल द्वारा लौटाए जाते हैं।

जब एक अवैतनिक चक्र अपने dueAt टाइमस्टैम्प से कम से कम 24 घंटे पहले हो जाता है, तो सदस्यताएँ overdue पर चली जाती हैं। जब भी सदस्यता की स्थिति बदलती है तो MakePay एक हस्ताक्षरित makepay.subscription.status_changed webhook भेजता है।

MakePaySettings

फ़ील्ड	प्रकार	नोट्स
`status`	`"active" \| "paused"`	टीम के लिए उत्पाद की उपलब्धता.
`defaultDestinationAsset`	`string \| null`	डिफ़ॉल्ट परिसंपत्ति पहचानकर्ता का उपयोग तब किया जाता है जब भुगतान लिंक केवल `currency` प्रदान करते हैं।
`feePaidBy`	`"client" \| "merchant"`	यह निर्धारित करता है कि ग्राहक या व्यापारी MakePay शुल्क को अवशोषित करता है या नहीं।
`returnRedirectUrl`	`string \| null`	checkout के बाद फ़ॉलबैक रीडायरेक्ट।
`successRedirectUrl`	`string \| null`	पूर्ण भुगतान के बाद पुनर्निर्देशित करें।
`failureRedirectUrl`	`string \| null`	रद्द या विफल भुगतान के बाद पुनर्निर्देशित करें।
`underpaymentPercentEnabled`	`boolean`	प्रतिशत सहनशीलता सक्षम करता है.
`underpaymentPercentThreshold`	`number`	अनुमत कम भुगतान प्रतिशत.
`underpaymentFixedEnabled`	`boolean`	निश्चित सहनशीलता को सक्षम बनाता है.
`underpaymentFixedThreshold`	`number`	निर्धारित कम भुगतान राशि की अनुमति।

DestinationAsset

फ़ील्ड	प्रकार	नोट्स
`assetIdentifier`	`string`	विहित श्रृंखला, प्रतीक और अनुबंध पहचानकर्ता।
`chainCode`	`string`	निपटान श्रृंखला कोड.
`chainName`	`string`	मानव-पठनीय श्रृंखला का नाम.
`symbol`	`string`	संपत्ति का प्रतीक.
`name`	`string`	संपत्ति का नाम.
`decimals`	`number`	सांकेतिक दशमलव.
`isDefault`	`boolean`	क्या यह संपत्ति वर्तमान कंपनी की डिफॉल्ट है।

स्थिति मान

active: लिंक खोला और भुगतान किया जा सकता है।
paused: लिंक व्यापारी के लिए दृश्यमान रहता है लेकिन नए भुगतान प्रारंभ को स्वीकार नहीं करना चाहिए।
archived: लिंक सक्रिय दृश्यों से छिपा हुआ है और इसे बंद माना जाना चाहिए।

Subscription स्थिति मान:

active: सदस्यता सामान्य रूप से निर्धारित चालान एकत्र कर रही है।
paused: अनुस्मारक और व्यापारी/ग्राहक परिवर्तनों ने सदस्यता रोक दी है।
overdue: कम से कम एक अवैतनिक चक्र अपनी नियत तारीख से 24 घंटे या अधिक समय बीत चुका है।
cancelled: सदस्यता समाप्त हो गई है और अवैतनिक उत्पन्न चक्र रद्द कर दिए गए हैं।

त्रुटि आकार

त्रुटियाँ error के साथ JSON लौटाती हैं और, उपलब्ध होने पर, errorCode लौटाती हैं।

{
  "errorCode": "invalid_destination_asset",
  "error": "payload.asset ETH.USDT-... is not available for supported settlement routes."
}