Référence API

Référence

Routes, modèles d'objet, énumérations, configuration et formatage des erreurs.

Référence de l'itinéraire

MéthodeRoute
GET/api/partner/v1/companies

Auth

Session

Usage

Lister les entreprises de l'utilisateur

Renvoie les équipes disponibles pour les outils du portail de l'utilisateur MakeCrypto authentifié.

POST/api/partner/v1/onboarding/company

Auth

Secret d'onboarding partenaire

Usage

Créer un lien d'onboarding d'entreprise

Crée un brouillon d'onboarding prérempli par le partenaire et renvoie une URL de réclamation pour le marchand.

GET/api/partner/v1/makepay/payment-links

Auth

Clé API MakePay

Usage

Lister ou créer des liens de paiement

Lit les liens de paiement de l'entreprise associée à la clé API ou crée des liens de checkout MakePay hébergés.

POST/api/partner/v1/makepay/payment-links

Auth

Clé API MakePay ou public

Usage

Lister ou créer des liens de paiement

Lit les liens de paiement de l'entreprise associée à la clé API ou crée des liens de checkout MakePay hébergés.

POST/gateway/pay/{makepayKeyId}

Auth

Clé de formulaire publique

Usage

Soumettre un formulaire de paiement HTML

Reçoit les champs de formulaire du navigateur, crée un lien de paiement hébergé, puis redirige l'acheteur vers le checkout.

GET/api/partner/v1/makepay/payment-links/{uid}

Auth

Clé API MakePay

Usage

Lire ou mettre à jour un lien de paiement

Lit le détail d'un lien de paiement ou change son statut en active, paused ou archived.

PATCH/api/partner/v1/makepay/payment-links/{uid}

Auth

Clé API MakePay

Usage

Lire ou mettre à jour un lien de paiement

Lit le détail d'un lien de paiement ou change son statut en active, paused ou archived.

POST/api/partner/v1/makepay/payment-links/{uid}/send-request-email

Auth

Clé API MakePay

Usage

Envoyer une demande de paiement

Envoie ou renvoie le lien hébergé à l'e-mail du client.

GET/api/partner/v1/makepay/subscriptions

Auth

Clé API MakePay

Usage

Lister ou créer des abonnements

Renvoie les plans d'abonnement récurrents MakePay ou crée un abonnement et la première facture.

POST/api/partner/v1/makepay/subscriptions

Auth

Clé API MakePay

Usage

Lister ou créer des abonnements

Renvoie les plans d'abonnement récurrents MakePay ou crée un abonnement et la première facture.

GET/api/partner/v1/makepay/customers

Auth

Clé API MakePay

Usage

Lister ou mettre à jour les clients

Renvoie les profils clients MakePay ou crée/met à jour des clients par e-mail.

POST/api/partner/v1/makepay/customers

Auth

Clé API MakePay

Usage

Lister ou mettre à jour les clients

Renvoie les profils clients MakePay ou crée/met à jour des clients par e-mail.

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

Auth

Clé API MakePay

Usage

Créer un lien de portail client

Génère à la demande une URL signée du portail client MakePay valable 24 heures.

GET/api/partner/v1/timezones

Auth

Public

Usage

Lister les fuseaux horaires

Renvoie les identifiants de fuseaux horaires IANA pris en charge.

GET/api/partner/v1/makepay/settings

Auth

Clé API MakePay

Usage

Lire ou mettre à jour les paramètres MakePay

Lit ou met à jour les paramètres de règlement, de redirection, de frais et de gestion des sous-paiements.

PUT/api/partner/v1/makepay/settings

Auth

Clé API MakePay

Usage

Lire ou mettre à jour les paramètres MakePay

Lit ou met à jour les paramètres de règlement, de redirection, de frais et de gestion des sous-paiements.

GET/api/partner/v1/makepay/destination-assets

Auth

Clé API MakePay

Usage

Lister les actifs de destination

Renvoie les actifs de règlement pris en charge et l'actif par défaut actuel.

GET/api/partner/v1/makepay/webhook-requests

Auth

Clé API MakePay

Usage

Lister les livraisons de webhook

Affiche les tentatives de livraison des webhooks de paiement et d'abonnement, ainsi que leur état de nouvelle tentative.

Intégration des partenaires OAuth

POST /api/partner/v1/onboarding/company peut inclure un objet oauth facultatif. MakeCrypto valide l'application OAuth, l'URI de redirection, les étendues et le défi PKCE avant de créer le lien d'intégration. Lorsque l'intégration du merchant est terminée, le MakeCrypto crée l'entreprise, accorde à l'application OAuth l'accès à cette entreprise et redirige vers le redirectUri enregistré avec une autorisation 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"
  }
}

L'application partenaire doit conserver le PKCE code_verifier correspondant et échanger le code renvoyé via POST /oauth/token.

ChampTaperRemarques
idstringUUID interne.
uidstringIdentifiant de lien de paiement public utilisé dans les itinéraires checkout hébergés et intégrés.
status"active" | "paused" | "archived"État du lien géré par le marchand.
payloadPaymentLinkPayloadChamps de commande marchand, de montant, de client, de redirection, de métadonnées, de marque et d'exécution.
created_atstringHorodatage ISO.
updated_atstringHorodatage ISO.
expires_atstring | nullHorodatage d’expiration résolu, ou null pour aucune expiration.
publicUrlstringMakePay checkout URL hébergé, inclus dans les réponses de création, de liste, de détail et de mise à jour de statut.

PaymentLinkPayload

ChampTaperRemarques
titlestringAfficher l’étiquette pour le paiement.
descriptionstringDescription destinée au client.
amountstringMontant décimal à percevoir.
fiatCurrencystringDevise d'affichage facultative telle que USD ou EUR.
currencystringSymbole de règlement tel que USDT, USDC ou BTC.
assetstringIdentifiant exact de l’actif de destination. Utilisez-le lorsqu'un symbole existe sur plusieurs chaînes.
orderIdstringRéférence de commande ou de facture marchand.
customerEmailstringUtilisé pour les demandes par courrier électronique et les charges utiles webhook.
clientIdstringIdentifiant client côté merchant en option.
returnUrlstringMarchand URL pour la navigation de retour générique.
successUrlstringMarchand URL pour les paiements effectués.
failureUrlstringMarchand URL pour les paiements échoués ou annulés.
expirationTime"15m" | "1h" | "12h" | "24h" | "72h" | "never"Durée de vie du lien de paiement demandé.
metadataRecord<string, unknown>Métadonnées définies par le marchand renvoyées dans les tableaux de bord et webhooks.
runtimeMode"merchant_target_net_v2"Injecté par le API pour de nouveaux liens de paiement.
billingVersion"v2"Injecté par le API pour de nouveaux liens de paiement.
merchantNamestringInjecté à partir de la marque de l’entreprise lorsqu’elle est disponible.
merchantPictureUrlstringInjecté à partir du profil de l’entreprise lorsqu’il est disponible.
merchantLogoUrlstringInjecté à partir de la marque merchant lorsqu'elle est disponible.
merchantPaymentLinkTheme"light" | "dark" | "system"Injecté à partir des paramètres du thème merchant checkout.

Objet client

ChampTaperRemarques
idstringUUID interne.
uidstringIdentifiant client public MakePay utilisé dans les liens du portail.
emailstringE-mail du client.
namestring | nullNom d’affichage du client. Modifiable depuis le portail client.
clientIdstring | nullIdentifiant client côté marchand. En lecture seule sur le portail.
metadataRecord<string, unknown>Métadonnées définies par le marchand.
createdAtstringHorodatage ISO.
updatedAtstringHorodatage ISO.
urls{ customerPortal: string }Présent sur les réponses de génération de portail. Ne persistez pas avec ce URL.

Réponse du portail client

POST /api/partner/v1/makepay/customers/{customerId}/portal renvoie un portail signé URL pour le client stocké.

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

Le URL est valable 24 heures et utilise le payment_link_domain vérifié par l'entreprise lorsqu'il est disponible. Sinon, il revient à l'origine publique MakePay.

Paramètre de requêteRemarques
companyID de compte d’entreprise MakeCrypto propriétaire du client.
customerClient MakePay UID.
expiresHorodatage Unix en secondes.
signatureSignature HMAC sur v1:{companyId}:{customerUid}:{expires}.

Générez des liens de portail à la demande lorsque le client ouvre la facturation. Les URL expirées, falsifiées ou inter-clients sont rejetées avant le chargement des données du portail.

Objet d'abonnement

ChampTaperRemarques
idstringUUID interne.
uidstringIdentifiant d'abonnement destiné au marchand.
status"active" | "paused" | "overdue" | "cancelled"État actuel de l'abonnement.
customerEmailstringE-mail client utilisé pour les rappels et la correspondance du portail.
labelstringÉtiquette d'abonnement destinée au client.
descriptionstring | nullDescription de l'abonnement facultative.
amountUsdstringMontant récurrent en USD.
settlementAssetstringIdentifiant de l'actif de règlement de destination.
cadence"weekly" | "biweekly" | "monthly" | "custom_months" | "yearly"Cadence d’affichage.
billingIntervalUnit"week" | "month" | "year"Unité d’intervalle de facturation.
billingIntervalCountnumberNombre d'unités entre les cycles de facturation.
startAtstringHorodatage ISO pour le premier cycle de facturation.
timezonestringFuseau horaire IANA utilisé pour la synchronisation des rappels.
metadataRecord<string, unknown>Métadonnées définies par le marchand et paramètres avancés de redirection/tolérance.
cyclesSubscriptionCycle[]Cycles de facturation générés renvoyés par les itinéraires de liste et les appels au tableau de bord.

Les abonnements sont transférés vers overdue lorsqu'un cycle non payé dépasse d'au moins 24 heures son horodatage dueAt. MakePay envoie un makepay.subscription.status_changed webhook signé chaque fois que l'état de l'abonnement change.

MakePayParamètres

ChampTaperRemarques
status"active" | "paused"Disponibilité des produits pour l'équipe.
defaultDestinationAssetstring | nullIdentifiant d'actif par défaut utilisé lorsque les liens de paiement fournissent uniquement currency.
feePaidBy"client" | "merchant"Détermine si le client ou le merchant absorbe les frais du MakePay.
returnRedirectUrlstring | nullRedirection de secours après checkout.
successRedirectUrlstring | nullRediriger après le paiement effectué.
failureRedirectUrlstring | nullRedirection après annulation ou échec de paiement.
underpaymentPercentEnabledbooleanActive le pourcentage de tolérance.
underpaymentPercentThresholdnumberPourcentage de sous-paiement autorisé.
underpaymentFixedEnabledbooleanPermet une tolérance fixe.
underpaymentFixedThresholdnumberMontant de sous-paiement fixe autorisé.

Actif de destination

ChampTaperRemarques
assetIdentifierstringChaîne canonique, symbole et identifiant de contrat.
chainCodestringCode de la chaîne de règlement.
chainNamestringNom de chaîne lisible par l’homme.
symbolstringSymbole d'actif.
namestringNom de l'actif.
decimalsnumberDécimales de jetons.
isDefaultbooleanSi cet actif est la valeur par défaut actuelle de l'entreprise.

Valeurs d'état

  • active : le lien peut être ouvert et payé.
  • paused : le lien reste visible pour le merchant mais ne doit pas accepter de nouveaux départs de paiement.
  • archived : le lien est masqué dans les vues actives et doit être traité comme fermé.

Valeurs de l'état de l'abonnement :

  • active : l'abonnement collecte normalement les factures programmées.
  • paused : les rappels et les modifications merchant/client ont mis l'abonnement en pause.
  • overdue : au moins un cycle non rémunéré a dépassé sa date d'échéance de 24 heures ou plus.
  • cancelled : l'abonnement est terminé et les cycles générés non payés sont annulés.

Forme d'erreur

Les erreurs renvoient JSON avec error et, le cas échéant, errorCode.

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

Besoin d'aide pour la configuration partenaire ?

Ouvrez la vue des détails du lien de paiement dans MakeCrypto pour copier les extraits générés pour un UID de paiement réel, ou revenez au portail pour gérer les paramètres du marchand.

Ouvrir le portail