API রেফারেন্স

রেফারেন্স

রুট, অবজেক্ট মডেল, enums, কনফিগারেশন এবং ত্রুটি বিন্যাস.

রুট রেফারেন্স

Method	Route
GET	`/api/partner/v1/companies`
Auth session Use ব্যবহারকারীর companies তালিকা authenticated MakeCrypto user-এর portal tools-এর জন্য উপলভ্য teams ফেরত দেয়.
POST	`/api/partner/v1/onboarding/company`
Auth partner onboarding secret Use Company onboarding link তৈরি করুন partner-pre-filled onboarding draft তৈরি করে এবং merchant-এর জন্য claim URL ফেরত দেয়.
GET	`/api/partner/v1/makepay/payment-links`
Auth MakePay API key Use Payment links তালিকা করুন বা তৈরি করুন API key-এর company payment links পড়ে বা hosted MakePay checkout links তৈরি করে.
POST	`/api/partner/v1/makepay/payment-links`
Auth MakePay API key অথবা public Use Payment links তালিকা করুন বা তৈরি করুন 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 পড়ে বা status active, paused, অথবা archived-এ পরিবর্তন করে.
PATCH	`/api/partner/v1/makepay/payment-links/{uid}`
Auth MakePay API key Use Payment link পড়ুন বা update করুন payment link detail পড়ে বা status 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 তালিকা করুন বা তৈরি করুন recurring MakePay subscription plans ফেরত দেয় বা subscription এবং প্রথম invoice তৈরি করে.
POST	`/api/partner/v1/makepay/subscriptions`
Auth MakePay API key Use Subscriptions তালিকা করুন বা তৈরি করুন recurring MakePay subscription plans ফেরত দেয় বা subscription এবং প্রথম invoice তৈরি করে.
GET	`/api/partner/v1/makepay/customers`
Auth MakePay API key Use Customers তালিকা করুন বা update করুন MakePay customer profiles ফেরত দেয় অথবা email দিয়ে customers create/update করে.
POST	`/api/partner/v1/makepay/customers`
Auth MakePay API key Use Customers তালিকা করুন বা 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 তৈরি করে.
GET	`/api/partner/v1/timezones`
Auth public Use Timezones তালিকা করুন 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 তালিকা করুন supported settlement assets এবং current default asset ফেরত দেয়.
GET	`/api/partner/v1/makepay/webhook-requests`
Auth MakePay API key Use Webhook deliveries তালিকা করুন payment এবং subscription webhook delivery attempts ও retry status দেখায়.

পার্টনার অনবোর্ডিং OAuth

POST /api/partner/v1/onboarding/company একটি ঐচ্ছিক oauth বস্তু অন্তর্ভুক্ত করতে পারে। MakeCrypto OAuth অ্যাপকে বৈধ করে, অনবোর্ডিং লিঙ্ক তৈরি করার আগে URI, স্কোপ এবং PKCE চ্যালেঞ্জ রিডাইরেক্ট করে। যখন merchant অনবোর্ডিং সম্পূর্ণ করে, 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`	ISO টাইমস্ট্যাম্প।
`updated_at`	`string`	ISO টাইমস্ট্যাম্প।
`expires_at`	`string \| null`	মেয়াদ শেষ হওয়ার টাইমস্ট্যাম্প বা `null` মেয়াদ শেষ না হওয়ার জন্য সমাধান করা হয়েছে।
`publicUrl`	`string`	হোস্ট করা MakePay checkout URL, তৈরি, তালিকা, বিশদ এবং স্থিতি আপডেট প্রতিক্রিয়া অন্তর্ভুক্ত।

PaymentLinkPayload

মাঠ	টাইপ	নোট
`title`	`string`	পেমেন্টের জন্য লেবেল প্রদর্শন করুন।
`description`	`string`	গ্রাহক-মুখী বিবরণ।
`amount`	`string`	সংগ্রহ করতে দশমিক পরিমাণ।
`fiatCurrency`	`string`	ঐচ্ছিক প্রদর্শন মুদ্রা যেমন `USD` বা `EUR`।
`currency`	`string`	সেটেলমেন্ট চিহ্ন যেমন `USDT`, `USDC`, বা `BTC`।
`asset`	`string`	সঠিক গন্তব্য সম্পদ শনাক্তকারী। একাধিক চেইনে একটি প্রতীক বিদ্যমান থাকলে এটি ব্যবহার করুন।
`orderId`	`string`	বণিক আদেশ বা চালান রেফারেন্স.
`customerEmail`	`string`	ইমেল অনুরোধ এবং webhook পেলোডের জন্য ব্যবহৃত হয়।
`clientId`	`string`	ঐচ্ছিক merchant-পার্শ্বের গ্রাহক শনাক্তকারী।
`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`	পাওয়া গেলে merchant ব্র্যান্ডিং থেকে ইনজেকশন করা হয়।
`merchantPaymentLinkTheme`	`"light" \| "dark" \| "system"`	merchant checkout থিম সেটিংস থেকে ইনজেকশন করা হয়েছে।

গ্রাহক বস্তু

মাঠ	টাইপ	নোট
`id`	`string`	অভ্যন্তরীণ UUID।
`uid`	`string`	পোর্টাল লিঙ্কগুলিতে ব্যবহৃত সর্বজনীন MakePay গ্রাহক শনাক্তকারী৷
`email`	`string`	গ্রাহক ইমেল.
`name`	`string \| null`	গ্রাহক প্রদর্শনের নাম। গ্রাহক পোর্টাল থেকে সম্পাদনাযোগ্য।
`clientId`	`string \| null`	মার্চেন্ট-সাইড গ্রাহক শনাক্তকারী। পোর্টালে শুধুমাত্র পঠনযোগ্য।
`metadata`	`Record<string, unknown>`	বণিক-সংজ্ঞায়িত মেটাডেটা।
`createdAt`	`string`	ISO টাইমস্ট্যাম্প।
`updatedAt`	`string`	ISO টাইমস্ট্যাম্প।
`urls`	`{ customerPortal: string }`	পোর্টাল প্রজন্মের প্রতিক্রিয়া উপস্থাপন. এই URL জেদ করবেন না।

গ্রাহক পোর্টাল প্রতিক্রিয়া

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 স্বাক্ষর।

গ্রাহক যখন বিলিং খোলেন তখন চাহিদা অনুযায়ী পোর্টাল লিঙ্ক তৈরি করুন। পোর্টাল ডেটা লোড হওয়ার আগে মেয়াদোত্তীর্ণ, টেম্পারড বা ক্রস-কাস্টমার ইউআরএল প্রত্যাখ্যান করা হয়।

সাবস্ক্রিপশন অবজেক্ট

মাঠ	টাইপ	নোট
`id`	`string`	অভ্যন্তরীণ UUID।
`uid`	`string`	বণিক-মুখী সাবস্ক্রিপশন শনাক্তকারী।
`status`	`"active" \| "paused" \| "overdue" \| "cancelled"`	সাবস্ক্রিপশনের বর্তমান অবস্থা।
`customerEmail`	`string`	অনুস্মারক এবং পোর্টাল মিলের জন্য ব্যবহৃত গ্রাহক ইমেল।
`label`	`string`	গ্রাহক-মুখী সাবস্ক্রিপশন লেবেল।
`description`	`string \| null`	ঐচ্ছিক সদস্যতা বিবরণ.
`amountUsd`	`string`	পুনরাবৃত্ত USD পরিমাণ।
`settlementAsset`	`string`	গন্তব্য নিষ্পত্তি সম্পদ শনাক্তকারী.
`cadence`	`"weekly" \| "biweekly" \| "monthly" \| "custom_months" \| "yearly"`	ক্যাডেন্স প্রদর্শন।
`billingIntervalUnit`	`"week" \| "month" \| "year"`	বিলিং ব্যবধান ইউনিট।
`billingIntervalCount`	`number`	বিলিং চক্রের মধ্যে ইউনিটের সংখ্যা।
`startAt`	`string`	প্রথম বিলিং চক্রের জন্য ISO টাইমস্ট্যাম্প৷
`timezone`	`string`	IANA টাইমজোন রিমাইন্ডার টাইমিংয়ের জন্য ব্যবহার করা হয়েছে।
`metadata`	`Record<string, unknown>`	বণিক-সংজ্ঞায়িত মেটাডেটা এবং উন্নত পুনঃনির্দেশ/সহনশীলতা সেটিংস।
`cycles`	`SubscriptionCycle[]`	উত্পন্ন বিলিং চক্র তালিকা রুট এবং ড্যাশবোর্ড কল দ্বারা ফিরে.

সদস্যতাগুলি overdue এ চলে যায় যখন একটি অবৈতনিক চক্র তার dueAt টাইমস্ট্যাম্পের কমপক্ষে 24 ঘন্টা পরে থাকে। MakePay একটি স্বাক্ষরিত makepay.subscription.status_changed webhook পাঠায় যখনই সদস্যতার স্থিতি পরিবর্তন হয়।

MakePay সেটিংস

মাঠ	টাইপ	নোট
`status`	`"active" \| "paused"`	দলের জন্য পণ্য প্রাপ্যতা.
`defaultDestinationAsset`	`string \| null`	অর্থপ্রদানের লিঙ্কগুলি শুধুমাত্র `currency` প্রদান করলে ডিফল্ট সম্পদ শনাক্তকারী ব্যবহার করা হয়।
`feePaidBy`	`"client" \| "merchant"`	গ্রাহক বা merchant MakePay ফি শোষণ করে কিনা তা নির্ধারণ করে।
`returnRedirectUrl`	`string \| null`	checkout পরে ফলব্যাক পুনঃনির্দেশ।
`successRedirectUrl`	`string \| null`	সম্পূর্ণ অর্থপ্রদানের পরে পুনর্নির্দেশ করুন।
`failureRedirectUrl`	`string \| null`	বাতিল বা ব্যর্থ পেমেন্ট পরে পুনর্নির্দেশ.
`underpaymentPercentEnabled`	`boolean`	শতাংশ সহনশীলতা সক্ষম করে।
`underpaymentPercentThreshold`	`number`	অনুমোদিত কম পেমেন্ট শতাংশ.
`underpaymentFixedEnabled`	`boolean`	স্থির সহনশীলতা সক্ষম করে।
`underpaymentFixedThreshold`	`number`	অনুমোদিত স্থির কম অর্থপ্রদানের পরিমাণ।

গন্তব্য সম্পদ

মাঠ	টাইপ	নোট
`assetIdentifier`	`string`	ক্যানোনিকাল চেইন, প্রতীক এবং চুক্তি শনাক্তকারী।
`chainCode`	`string`	সেটেলমেন্ট চেইন কোড।
`chainName`	`string`	মানব-পাঠযোগ্য চেইন নাম।
`symbol`	`string`	সম্পদ প্রতীক।
`name`	`string`	সম্পদের নাম।
`decimals`	`number`	টোকেন দশমিক।
`isDefault`	`boolean`	এই সম্পদ বর্তমান কোম্পানি ডিফল্ট কিনা.

স্থিতি মান

active: লিঙ্কটি খোলা এবং অর্থ প্রদান করা যেতে পারে।
paused: লিঙ্কটি merchant-এর কাছে দৃশ্যমান থাকে তবে নতুন অর্থপ্রদান শুরু হওয়াকে গ্রহণ করা উচিত নয়।
archived: লিঙ্কটি সক্রিয় দৃষ্টিভঙ্গি থেকে লুকানো এবং বন্ধ হিসাবে বিবেচনা করা উচিত।

সদস্যতা স্থিতি মান:

active: সাবস্ক্রিপশন সাধারণত নির্ধারিত চালান সংগ্রহ করছে।
paused: অনুস্মারক এবং merchant/গ্রাহক পরিবর্তন সাবস্ক্রিপশন বিরাম দিয়েছে।
overdue: কমপক্ষে একটি অবৈতনিক চক্র তার নির্ধারিত তারিখের 24 ঘন্টা বা তার বেশি সময় পার করেছে।
cancelled: সাবস্ক্রিপশন শেষ হয়েছে এবং অবৈতনিক জেনারেট করা চক্র বাতিল করা হয়েছে।

ত্রুটি আকৃতি

ত্রুটিগুলি error এর সাথে JSON ফেরত দেয় এবং, যখন উপলব্ধ, errorCode।

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