MakePay NPM SDK

Überblick

Das MakePay npm SDK ist eine typisierte JavaScript- und TypeScript-Bibliothek für serverseitige MakePay-Integrationen. Es kapselt API-Schlüsselauthentifizierung, gehostete Zahlungslinkvorgänge, MakePay-Einstellungen und signierte Webhook-Überprüfung.

Paket:

@makecrypto/makepay

Installation

npm install @makecrypto/makepay

pnpm add @makecrypto/makepay

Das SDK unterstützt Node.js 18 oder neuer und verwendet die native fetch-Implementierung.

Authentifizierung

Erstellen Sie einen MakePay-API-Schlüssel im MakeCrypto-Entwicklerbereich für Händler und speichern Sie das Schlüsselgeheimnis nur auf Ihrem Server.

import { MakePayClient } from "@makecrypto/makepay";

const makepay = new MakePayClient({
  keyId: process.env.MAKEPAY_KEY_ID!,
  keySecret: process.env.MAKEPAY_KEY_SECRET!,
  // Optional: override only when MakePay gives you a custom checkout origin.
  checkoutBaseUrl: "https://makepay.io",
});

Das SDK sendet die Header x-makecrypto-key-id und x-makecrypto-key-secret an die Partner-API MakePay.

Zahlungslink erstellen

const response = await makepay.createPaymentLink({
  title: "Order #1042",
  description: "Checkout for order #1042",
  amount: "129.99",
  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/pay",
  expirationTime: "12h",
});

console.log(response.paymentLink);

Senden Sie während der Erstellung eine MakePay-Zahlungsanforderungs-E-Mail:

await makepay.createPaymentLink(payload, {
  sendPaymentRequestEmail: true,
});

Eingebetteter Checkout

Verwenden Sie gehostete Checkout-URLs für Weiterleitungen oder die Einbettungshilfen, wenn Ihr Frontend den Käufer auf der Händlerseite halten soll.

import {
  buildMakePayEmbeddedCheckoutUrl,
  buildMakePayHostedCheckoutUrl,
  mountMakePayCheckout,
  openMakePayCheckout,
} from "@makecrypto/makepay";

const paymentUid = response.paymentLink.uid;

const hostedUrl = buildMakePayHostedCheckoutUrl(paymentUid);
const embedUrl = buildMakePayEmbeddedCheckoutUrl(paymentUid, {
  parentOrigin: "https://merchant.example",
});

await openMakePayCheckout({
  paymentUid,
  onEvent(event) {
    if (event.type === "makepay.payment.redirect_requested") {
      window.location.assign(String(event.payload?.redirectUrl || hostedUrl));
    }
  },
});

mountMakePayCheckout({
  container: "#makepay-checkout",
  paymentUid,
});

Für statische CMS-Seiten gibt buildMakePayEmbedButtonHtml(paymentUid) einen Button-Snippet zurück, der das MakePay-Modal-Skript lädt.

Links lesen und aktualisieren

await makepay.listPaymentLinks();
await makepay.getPaymentLink("PAYMENT_LINK_UID");

await makepay.updatePaymentLink("PAYMENT_LINK_UID", {
  status: "paused",
});

await makepay.sendPaymentRequestEmail("PAYMENT_LINK_UID", "buyer@example.com");

Einstellungen

await makepay.getSettings();

await makepay.updateSettings({
  callbackUrl: "https://merchant.example/webhooks/makepay",
});

Webhook-Überprüfung

Lesen Sie den genauen Rohtext, bevor Sie JSON analysieren.

import { parseMakePayWebhook } from "@makecrypto/makepay";

export async function POST(request: Request) {
  const rawBody = await request.text();
  const event = parseMakePayWebhook(
    rawBody,
    request.headers.get("x-makepay-signature"),
    process.env.MAKEPAY_WEBHOOK_SECRET!,
  );

  if (event.event?.type === "status_changed") {
    // Update your local order.
  }

  return new Response("ok");
}

Verwenden Sie verifyMakePayWebhook, wenn Sie nur ein boolesches Ergebnis benötigen.

Fehlerbehandlung

API-Aufrufe lösen MakePayError aus. Der Fehler enthält den HTTP-Status und den dekodierten Antworttext.

import { MakePayError } from "@makecrypto/makepay";

try {
  await makepay.getPaymentLink("PAYMENT_LINK_UID");
} catch (error) {
  if (error instanceof MakePayError) {
    console.error(error.status, error.responseBody);
  }
}

Quelllayout

Die kanonische Quelle befindet sich in apps/plugins/npm-sdk. Das veröffentlichte npm-Paket enthält kompilierte ESM-JavaScript- und TypeScript-Deklarationen von dist.

Versionshinweise

Das Paket wird als @makecrypto/makepay mit öffentlichem Zugriff veröffentlicht. Releases sollten ein npm-Automatisierungstoken in der Organisation makecrypto verwenden oder ein OTP-fähiges Token, wenn 2FA erforderlich ist.