API-Referenz
Referenz
Routen, Objektmodelle, Aufzählungen, Einstellungen und Fehlerformen.
Routenreferenz
| Methode | Route |
|---|---|
| GET | /api/partner/v1/companies |
Authentifizierung Sitzung Verwendung Benutzerunternehmen auflisten Gibt die Teams zurück, die für die Portaltools des authentifizierten MakeCrypto-Benutzers verfügbar sind. | |
| POST | /api/partner/v1/onboarding/company |
Authentifizierung Partner-Onboarding-Secret Verwendung Onboarding-Link für Unternehmen erstellen Erstellt einen vom Partner vorausgefüllten Onboarding-Entwurf und gibt eine Claim-URL für den Händler zurück. | |
| GET | /api/partner/v1/makepay/payment-links |
Authentifizierung MakePay API-Schlüssel Verwendung Zahlungslinks auflisten oder erstellen Liest Zahlungslinks des Unternehmens, das zum API-Schlüssel gehört, oder erstellt gehostete MakePay-Checkout-Links. | |
| POST | /api/partner/v1/makepay/payment-links |
Authentifizierung MakePay API-Schlüssel oder öffentlich Verwendung Zahlungslinks auflisten oder erstellen Liest Zahlungslinks des Unternehmens, das zum API-Schlüssel gehört, oder erstellt gehostete MakePay-Checkout-Links. | |
| POST | /gateway/pay/{makepayKeyId} |
Authentifizierung Öffentlicher Formularschlüssel Verwendung HTML-Zahlungsformular senden Nimmt Formularfelder aus dem Browser an, erstellt einen gehosteten Zahlungslink und leitet den Käufer zum Checkout weiter. | |
| GET | /api/partner/v1/makepay/payment-links/{uid} |
Authentifizierung MakePay API-Schlüssel Verwendung Zahlungslink lesen oder aktualisieren Liest Details eines Zahlungslinks oder setzt seinen Status auf active, paused oder archived. | |
| PATCH | /api/partner/v1/makepay/payment-links/{uid} |
Authentifizierung MakePay API-Schlüssel Verwendung Zahlungslink lesen oder aktualisieren Liest Details eines Zahlungslinks oder setzt seinen Status auf active, paused oder archived. | |
| POST | /api/partner/v1/makepay/payment-links/{uid}/send-request-email |
Authentifizierung MakePay API-Schlüssel Verwendung Zahlungsanforderung senden Sendet den gehosteten Link oder sendet ihn erneut an die E-Mail-Adresse des Kunden. | |
| GET | /api/partner/v1/makepay/subscriptions |
Authentifizierung MakePay API-Schlüssel Verwendung Abonnements auflisten oder erstellen Gibt wiederkehrende MakePay-Abonnementpläne zurück oder erstellt ein Abonnement und die erste Rechnung. | |
| POST | /api/partner/v1/makepay/subscriptions |
Authentifizierung MakePay API-Schlüssel Verwendung Abonnements auflisten oder erstellen Gibt wiederkehrende MakePay-Abonnementpläne zurück oder erstellt ein Abonnement und die erste Rechnung. | |
| GET | /api/partner/v1/makepay/customers |
Authentifizierung MakePay API-Schlüssel Verwendung Kunden auflisten oder aktualisieren Gibt MakePay-Kundenprofile zurück oder erstellt/aktualisiert Kunden per E-Mail. | |
| POST | /api/partner/v1/makepay/customers |
Authentifizierung MakePay API-Schlüssel Verwendung Kunden auflisten oder aktualisieren Gibt MakePay-Kundenprofile zurück oder erstellt/aktualisiert Kunden per E-Mail. | |
| POST | /api/partner/v1/makepay/customers/{customerId}/portal |
Authentifizierung MakePay API-Schlüssel Verwendung Kundenportal-Link erstellen Generiert bei Bedarf eine signierte MakePay-Kundenportal-URL, die 24 Stunden gültig ist. | |
| GET | /api/partner/v1/timezones |
Authentifizierung Öffentlich Verwendung Zeitzonen auflisten Gibt unterstützte IANA-Zeitzonenkennungen zurück. | |
| GET | /api/partner/v1/makepay/settings |
Authentifizierung MakePay API-Schlüssel Verwendung MakePay-Einstellungen lesen oder aktualisieren Liest oder aktualisiert Einstellungen für Settlement, Weiterleitungen, Gebühren und Unterzahlungsbehandlung. | |
| PUT | /api/partner/v1/makepay/settings |
Authentifizierung MakePay API-Schlüssel Verwendung MakePay-Einstellungen lesen oder aktualisieren Liest oder aktualisiert Einstellungen für Settlement, Weiterleitungen, Gebühren und Unterzahlungsbehandlung. | |
| GET | /api/partner/v1/makepay/destination-assets |
Authentifizierung MakePay API-Schlüssel Verwendung Ziel-Assets auflisten Gibt unterstützte Settlement-Assets und das aktuelle Standard-Asset zurück. | |
| GET | /api/partner/v1/makepay/webhook-requests |
Authentifizierung MakePay API-Schlüssel Verwendung Webhook-Zustellungen auflisten Zeigt Zustellversuche für Payment- und Subscription-Webhooks sowie den Wiederholungsstatus. | |
Partner-Onboarding OAuth
POST /api/partner/v1/onboarding/company kann optional einen oauth enthalten
Objekt. MakeCrypto validiert die OAuth-App, den Umleitungs-URI, die Bereiche und PKCE
Herausforderung, bevor Sie den Onboarding-Link erstellen. Wenn der Händler fertig ist
Beim Onboarding erstellt MakeCrypto das Unternehmen und gewährt der OAuth-App Zugriff darauf
Unternehmen und leitet mit einer Autorisierung zum registrierten redirectUri weiter
code.
{
"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"
}
}
Die Partner-App sollte das passende PKCE code_verifier behalten und austauschen
zurückgegebener Code über POST /oauth/token.
PaymentLink-Objekt
| Feld | Typ | Notizen |
|---|---|---|
id | string | Interne UUID. |
uid | string | Öffentliche Zahlungslink-ID, die in gehosteten und eingebetteten Checkout-Routen verwendet wird. |
status | "active" | "paused" | "archived" | Vom Händler verwalteter Linkstatus. |
payload | PaymentLinkPayload | Händlerauftrags-, Betrags-, Kunden-, Weiterleitungs-, Metadaten-, Branding- und Laufzeitfelder. |
created_at | string | ISO-Zeitstempel. |
updated_at | string | ISO-Zeitstempel. |
expires_at | string | null | Aufgelöster Ablaufzeitstempel oder null für keinen Ablauf. |
publicUrl | string | Gehostete MakePay-Checkout-URL, enthalten in den Erstellungs-, Listen-, Detail- und Statusaktualisierungsantworten. |
PaymentLinkPayload
| Feld | Typ | Notizen |
|---|---|---|
title | string | Anzeigeetikett für die Zahlung. |
description | string | Kundenorientierte Beschreibung. |
amount | string | Dezimaler Betrag, der eingezogen werden soll. |
fiatCurrency | string | Optionale Anzeigewährung wie USD oder EUR. |
currency | string | Abrechnungssymbol wie USDT, USDC oder BTC. |
asset | string | Genaue Ziel-Asset-ID. Verwenden Sie dies, wenn ein Symbol in mehreren Ketten vorhanden ist. |
orderId | string | Händlerbestellung oder Rechnungsreferenz. |
customerEmail | string | Wird für E-Mail-Anfragen und Webhook-Nutzlasten verwendet. |
clientId | string | Optionale Kundenkennung auf Händlerseite. |
returnUrl | string | Händler-URL für die allgemeine Rückgabenavigation. |
successUrl | string | Händler-URL für abgeschlossene Zahlungen. |
failureUrl | string | Händler-URL für fehlgeschlagene oder stornierte Zahlungen. |
expirationTime | "15m" | "1h" | "12h" | "24h" | "72h" | "never" | Angeforderte Lebensdauer des Zahlungslinks. |
metadata | Record<string, unknown> | Vom Händler definierte Metadaten, die in Dashboards und Webhooks zurückgegeben werden. |
runtimeMode | "merchant_target_net_v2" | Von der API für neue Zahlungslinks eingefügt. |
billingVersion | "v2" | Von der API für neue Zahlungslinks eingefügt. |
merchantName | string | Sofern verfügbar, aus dem Branding des Unternehmens eingespritzt. |
merchantPictureUrl | string | Wird aus dem Firmenprofil eingefügt, sofern verfügbar. |
merchantLogoUrl | string | Wird aus dem Händler-Branding eingefügt, sofern verfügbar. |
merchantPaymentLinkTheme | "light" | "dark" | "system" | Eingefügt aus den Checkout-Themeneinstellungen des Händlers. |
Kundenobjekt
| Feld | Typ | Notizen |
|---|---|---|
id | string | Interne UUID. |
uid | string | Öffentliche MakePay-Kundenkennung, die in Portal-Links verwendet wird. |
email | string | Kunden-E-Mail. |
name | string | null | Anzeigename des Kunden. Bearbeitbar über das Kundenportal. |
clientId | string | null | Händlerseitige Kundenkennung. Im Portal schreibgeschützt. |
metadata | Record<string, unknown> | Vom Händler definierte Metadaten. |
createdAt | string | ISO-Zeitstempel. |
updatedAt | string | ISO-Zeitstempel. |
urls | { customerPortal: string } | Präsentieren Sie Antworten zur Portalgenerierung. Behalten Sie diese URL nicht bei. |
Antwort des Kundenportals
POST /api/partner/v1/makepay/customers/{customerId}/portal
gibt eine signierte Portal-URL für den hinterlegten Kunden zurück.
{
"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"
}Die URL ist 24 Stunden lang gültig und verwendet die verifizierte URL des Unternehmens
payment_link_domain, sofern verfügbar. Andernfalls wird auf MakePay zurückgegriffen
öffentliche Herkunft.
| Abfrageparameter | Notizen |
|---|---|
company | MakeCrypto Firmenkonto-ID, zu der der Kunde gehört. |
customer | MakePay Kunden-UID. |
expires | Unix-Zeitstempel in Sekunden. |
signature | HMAC-Signatur über v1:{companyId}:{customerUid}:{expires}. |
Generieren Sie bei Bedarf Portal-Links, wenn der Kunde die Abrechnung öffnet. Abgelaufen, Manipulierte oder kundenübergreifende URLs werden abgelehnt, bevor Portaldaten geladen werden.
Abonnementobjekt
| Feld | Typ | Notizen |
|---|---|---|
id | string | Interne UUID. |
uid | string | Händlerseitige Abonnement-ID. |
status | "active" | "paused" | "overdue" | "cancelled" | Aktueller Abonnementstatus. |
customerEmail | string | Kunden-E-Mail, die für Erinnerungen und Portalabgleich verwendet wird. |
label | string | Kundenorientiertes Abonnementetikett. |
description | string | null | Optionale Abonnementbeschreibung. |
amountUsd | string | Wiederkehrender USD-Betrag. |
settlementAsset | string | Identifikator des Zielabrechnungsvermögens. |
cadence | "weekly" | "biweekly" | "monthly" | "custom_months" | "yearly" | Trittfrequenz anzeigen. |
billingIntervalUnit | "week" | "month" | "year" | Abrechnungsintervalleinheit. |
billingIntervalCount | number | Anzahl der Einheiten zwischen Abrechnungszyklen. |
startAt | string | ISO-Zeitstempel für den ersten Abrechnungszyklus. |
timezone | string | IANA-Zeitzone, die für den Erinnerungszeitpunkt verwendet wird. |
metadata | Record<string, unknown> | Vom Händler definierte Metadaten und erweiterte Weiterleitungs-/Toleranzeinstellungen. |
cycles | SubscriptionCycle[] | Generierte Abrechnungszyklen, die von Listenrouten und Dashboard-Aufrufen zurückgegeben werden. |
Abonnements werden auf overdue verschoben, wenn ein unbezahlter Zyklus mindestens 24 Stunden zurückliegt
sein dueAt-Zeitstempel. MakePay sendet eine signierte
makepay.subscription.status_changed-Webhook bei jedem Abonnementstatus
Änderungen.
MakePaySettings
| Feld | Typ | Notizen |
|---|---|---|
status | "active" | "paused" | Produktverfügbarkeit für das Team. |
defaultDestinationAsset | string | null | Standard-Asset-ID, die verwendet wird, wenn Zahlungslinks nur currency bereitstellen. |
feePaidBy | "client" | "merchant" | Legt fest, ob der Kunde oder Händler die Gebühren von MakePay übernimmt. |
returnRedirectUrl | string | null | Fallback-Weiterleitung nach dem Bezahlvorgang. |
successRedirectUrl | string | null | Weiterleitung nach abgeschlossener Zahlung. |
failureRedirectUrl | string | null | Weiterleitung nach stornierter oder fehlgeschlagener Zahlung. |
underpaymentPercentEnabled | boolean | Aktiviert prozentuale Toleranz. |
underpaymentPercentThreshold | number | Zulässiger Unterzahlungsprozentsatz. |
underpaymentFixedEnabled | boolean | Aktiviert eine feste Toleranz. |
underpaymentFixedThreshold | number | Zulässiger fester Unterzahlungsbetrag. |
ZielAsset
| Feld | Typ | Notizen |
|---|---|---|
assetIdentifier | string | Kanonische Kette, Symbol und Vertragskennung. |
chainCode | string | Code der Abrechnungskette. |
chainName | string | Für Menschen lesbarer Kettenname. |
symbol | string | Vermögenssymbol. |
name | string | Asset-Name. |
decimals | number | Token-Dezimalstellen. |
isDefault | boolean | Ob es sich bei diesem Vermögenswert um den aktuellen Firmenstandard handelt. |
Statuswerte
active: Der Link kann geöffnet und bezahlt werden.paused: Der Link bleibt für den Händler sichtbar, sollte aber keine neuen Zahlungsstarts akzeptieren.archived: Der Link ist in aktiven Ansichten verborgen und sollte als geschlossen behandelt werden.
Abonnementstatuswerte:
active: Das Abonnement erfasst geplante Rechnungen normal.paused: Erinnerungen und Händler-/Kundenänderungen haben das Abonnement pausiert.overdue: Mindestens ein unbezahlter Zyklus liegt 24 Stunden oder mehr über dem Fälligkeitsdatum.cancelled: Das Abonnement wird beendet und unbezahlte generierte Zyklen werden storniert.
Fehlerform
Fehler geben JSON mit error und, sofern verfügbar, errorCode zurück.
{
"errorCode": "invalid_destination_asset",
"error": "payload.asset ETH.USDT-... is not available for supported settlement routes."
}