API-Referenz

Kundenportal-API

Generieren Sie signierte MakePay-Kundenportal-URLs für gespeicherte Kunden.

Erstellen Sie einen MakePay-Kundenportal-Link aus einem gespeicherten MakePay-Kundenprofil. Generieren Sie den Link also nur, wenn der Kunde oder Händler auf die Abrechnung klickt Leiten Sie die zurückgegebene URL weiter oder öffnen Sie sie.

POST /api/partner/v1/makepay/customers/{customerId}/portal

customerId akzeptiert die hinterlegte Kunden-UUID bzw. Kunden-UID. Der Anforderungstext ist leer.

curl
curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/customers/CUSTOMER_ID/portal" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

Authentifizierung

Serverintegrationen authentifizieren sich mit einem MakePay-API-Schlüssel. Browsersitzungen können Rufen Sie die unternehmensweite Dashboard-Route auf, wenn der angemeldete Benutzer dies getan hat settings.manage im ausgewählten Team. API-Schlüsselanfragen gehen nicht an einem Unternehmen vorbei ID in der URL, da der Schlüssel bereits zu einem Unternehmen gehört.

HeaderWertHinweise
x-makecrypto-key-idMakePay API-Schlüssel-IDBeginnt mit mk_makepay_ für MakePay-Zahlungs-APIs.
x-makecrypto-key-secretEinmaliges API-SecretWird nur beim Erstellen des Schlüssels angezeigt. Speichern Sie es in Ihrem serverseitigen Secret-Manager.

Antwort

Die Route gibt das Kundenobjekt plus einen signierten urls.customerPortal-Link zurück.

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"
}

Signierte URL-Parameter

Die zurückgegebene Portal-URL hat folgende Form:

https://{makepay-or-verified-merchant-domain}/billing?company={companyId}&customer={customerUid}&expires={unixSeconds}&signature={hexHmac}
ParameterNotizen
companyMakeCrypto Firmenkonto-ID, zu der der Kunde gehört.
customerDie Kunden-UID MakePay ist auf dieses Unternehmen beschränkt.
expiresUnix-Zeitstempel in Sekunden. Links sind 24 Stunden gültig.
signatureHMAC-Signatur über die Versions-, Firmen-, Kunden- und Ablaufwerte.

MakePay überprüft die Signatur und den Ablauf, bevor Portaldaten geladen werden. Tun Portal-URLs nicht dauerhaft speichern. Generieren Sie bei jedem Klick auf die Schaltfläche einen neuen Link.

Portalumfang

Das Portal zeigt nur Daten an, die zum signierten Unternehmen und Kunden passen:

  • Zusammenfassung des Kundenprofils und bearbeitbarer Anzeigename.
  • Der Zahlungsverlauf wird mit der E-Mail-Adresse des Kunden oder der Kunden-ID abgeglichen.
  • Aktive oder unbezahlte Zahlungslinks mit gehosteten MakePay-URLs.
  • Abonnements, die nach Kunden-E-Mail oder Metadaten-Client-ID abgeglichen werden.
  • Aktionen für unterstützte Abonnementstatus pausieren, reaktivieren und abbrechen.

E-Mail, Kunden-ID, PDFs, Zahlungsmethoden, Lizenzschlüssel, Planwechsel und Lebenslaufabläufe bei gekündigtem Abonnement sind in der ersten Portalversion nicht veränderbar.

Benötigen Sie Hilfe bei der Partnereinrichtung?

Öffnen Sie die Detailansicht des Zahlungslinks in MakeCrypto, um die generierten Snippets für eine echte Zahlungs-UID zu kopieren, oder kehren Sie zum Portal zurück, um Händlereinstellungen zu verwalten.

Portal öffnen