Dokumentacja API

Linki płatnicze API

Twórz, wyświetlaj, sprawdzaj, wstrzymuj, archiwizuj i wysyłaj e-mailem linki do płatności MakePay.

Trasy

Użyj tych tras, aby utworzyć i zarządzać hostowanymi łączami płatniczymi MakePay z poziomu MakeCrypto.

Metoda	Trasa
GET	`/api/partner/v1/companies`
Autoryzacja Sesja Zastosowanie Lista firm użytkownika Zwraca zespoły dostępne dla narzędzi portalu zalogowanego użytkownika MakeCrypto.
POST	`/api/partner/v1/onboarding/company`
Autoryzacja Sekret onboardingu partnera Zastosowanie Utwórz link onboardingu firmy Tworzy wstępnie wypełniony przez partnera szkic onboardingu i zwraca adres URL do przejęcia przez sprzedawcę.
GET	`/api/partner/v1/makepay/payment-links`
Autoryzacja Klucz MakePay API Zastosowanie Wyświetl lub utwórz linki płatnicze Odczytuje linki płatnicze firmy przypisanej do klucza API albo tworzy hostowane linki checkout MakePay.
POST	`/api/partner/v1/makepay/payment-links`
Autoryzacja Klucz MakePay API albo publiczne Zastosowanie Wyświetl lub utwórz linki płatnicze Odczytuje linki płatnicze firmy przypisanej do klucza API albo tworzy hostowane linki checkout MakePay.
POST	`/gateway/pay/{makepayKeyId}`
Autoryzacja Publiczny klucz formularza Zastosowanie Wyślij formularz płatności HTML Przyjmuje pola formularza z przeglądarki, tworzy hostowany link płatniczy i przekierowuje kupującego do checkout.
GET	`/api/partner/v1/makepay/payment-links/{uid}`
Autoryzacja Klucz MakePay API Zastosowanie Odczytaj lub zaktualizuj link płatniczy Odczytuje szczegóły linku płatniczego albo zmienia jego status na active, paused lub archived.
PATCH	`/api/partner/v1/makepay/payment-links/{uid}`
Autoryzacja Klucz MakePay API Zastosowanie Odczytaj lub zaktualizuj link płatniczy Odczytuje szczegóły linku płatniczego albo zmienia jego status na active, paused lub archived.
POST	`/api/partner/v1/makepay/payment-links/{uid}/send-request-email`
Autoryzacja Klucz MakePay API Zastosowanie Wyślij żądanie płatności Wysyła lub ponownie wysyła hostowany link na adres e-mail klienta.
GET	`/api/partner/v1/makepay/subscriptions`
Autoryzacja Klucz MakePay API Zastosowanie Wyświetl lub utwórz subskrypcje Zwraca cykliczne plany subskrypcji MakePay albo tworzy subskrypcję i pierwszą fakturę.
POST	`/api/partner/v1/makepay/subscriptions`
Autoryzacja Klucz MakePay API Zastosowanie Wyświetl lub utwórz subskrypcje Zwraca cykliczne plany subskrypcji MakePay albo tworzy subskrypcję i pierwszą fakturę.
GET	`/api/partner/v1/makepay/customers`
Autoryzacja Klucz MakePay API Zastosowanie Wyświetl lub zaktualizuj klientów Zwraca profile klientów MakePay albo tworzy/aktualizuje klientów po adresie e-mail.
POST	`/api/partner/v1/makepay/customers`
Autoryzacja Klucz MakePay API Zastosowanie Wyświetl lub zaktualizuj klientów Zwraca profile klientów MakePay albo tworzy/aktualizuje klientów po adresie e-mail.
POST	`/api/partner/v1/makepay/customers/{customerId}/portal`
Autoryzacja Klucz MakePay API Zastosowanie Utwórz link do portalu klienta Generuje na żądanie podpisany adres URL portalu klienta MakePay ważny przez 24 godziny.
GET	`/api/partner/v1/timezones`
Autoryzacja Publiczne Zastosowanie Wyświetl strefy czasowe Zwraca obsługiwane identyfikatory stref czasowych IANA.
GET	`/api/partner/v1/makepay/settings`
Autoryzacja Klucz MakePay API Zastosowanie Odczytaj lub zaktualizuj ustawienia MakePay Odczytuje lub aktualizuje ustawienia rozliczeń, przekierowań, opłat i obsługi niedopłat.
PUT	`/api/partner/v1/makepay/settings`
Autoryzacja Klucz MakePay API Zastosowanie Odczytaj lub zaktualizuj ustawienia MakePay Odczytuje lub aktualizuje ustawienia rozliczeń, przekierowań, opłat i obsługi niedopłat.
GET	`/api/partner/v1/makepay/destination-assets`
Autoryzacja Klucz MakePay API Zastosowanie Wyświetl aktywa docelowe Zwraca obsługiwane aktywa rozliczeniowe i bieżące aktywo domyślne.
GET	`/api/partner/v1/makepay/webhook-requests`
Autoryzacja Klucz MakePay API Zastosowanie Wyświetl dostarczenia webhooków Pokazuje próby dostarczenia webhooków płatności i subskrypcji wraz ze statusem ponowienia.

Utwórz link do płatności

Funkcja tworzenia trasy wstawia łącze płatnicze MakePay, rozwiązuje domyślne ustawienia marki sprzedawcy i rozliczeń, wstawia pola rozliczeniowe w czasie wykonywania i zwraca publiczny adres URL checkout.

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

json

{
  "status": "active",
  "sendPaymentRequestEmail": false,
  "payload": {
    "title": "Website order #1042",
    "description": "Checkout for order #1042",
    "amount": "129.99",
    "fiatCurrency": "USD",
    "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/failure",
    "expirationTime": "12h",
    "metadata": {
      "cartId": "cart_7M2V",
      "source": "api"
    }
  }
}

Informacje na temat przycisku przeglądarki bez kodu lub o niskim kodzie checkout można znaleźć w artykule Formularz przesyłania płatności. Akceptuje zwykły kod HTML POST tworzy ten sam rodzaj hostowanego łącza płatniczego i przekierowuje kupującego do MakePay checkout.

Wymagana konfiguracja

Firma musi mieć domyślny zasób docelowy MakePay. Jeśli rozliczenie nie jest skonfigurowane, trasa zwraca 409 z errorCode: "onboarding_required".

Pola kwoty i zasobu

W przypadku kwoty przeznaczonej dla klienta użyj payload.amount. Przekaż payload.asset dla dokładnego zasobu docelowego lub payload.currency, gdy domyślny zasób docelowy firmy może rozwiązać łańcuch. Jeśli waluta jest włączona w wielu łańcuchach i nie istnieje żadna domyślna waluta pasująca do firmy, jawnie przekaż payload.asset.

Wygaśnięcie

payload.expirationTime akceptuje 15m, 1h, 12h, 24h, 72h lub never. API przechowuje rozwiązany znacznik czasu expires_at na łączu płatniczym.

Utwórz odpowiedź

json

{
  "ok": true,
  "paymentRequestEmailSent": false,
  "paymentRequestEmailError": null,
  "paymentLink": {
    "id": "8d15bb78-d0f8-45ef-88d7-2a1f1f79644b",
    "uid": "01hzy4k6p4w9y2x7e2z7n8a2xm",
    "status": "active",
    "expires_at": "2026-04-19T12:00:00.000Z",
    "created_at": "2026-04-19T00:00:00.000Z",
    "updated_at": "2026-04-19T00:00:00.000Z",
    "publicUrl": "https://makepay.io/payment/01hzy4k6p4w9y2x7e2z7n8a2xm",
    "payload": {
      "title": "Website order #1042",
      "description": "Checkout for order #1042",
      "amount": "129.99",
      "fiatCurrency": "USD",
      "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/failure",
      "expirationTime": "12h",
      "metadata": {
        "cartId": "cart_7M2V",
        "source": "api"
      },
      "asset": "ETH.USDT-0xdac17f958d2ee523a2206206994597c13d831ec7",
      "runtimeMode": "merchant_target_net_v2",
      "billingVersion": "v2",
      "merchantName": "Merchant Co",
      "merchantPaymentLinkTheme": "system"
    }
  }
}

Lista linków płatniczych

Użyj trasy listy do uzgadniania zaplecza, pulpitów nawigacyjnych i testów dymnych.

curl

curl "https://www.makecrypto.io/api/partner/v1/makepay/payment-links" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

Uzyskaj szczegóły linku do płatności

Użyj trasy szczegółowej, jeśli masz już identyfikator UID łącza płatniczego i potrzebujesz znormalizowanego łącza, publicznego adresu URL checkout, ostatniej sesji płatności i zdarzeń na osi czasu.

curl

curl "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

Wstrzymaj lub zarchiwizuj link do płatności

Użyj trasy statusu, aby zatrzymać opłacanie linku lub ukryć go przed aktywnymi operacjami.

curl

curl -X PATCH "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"status":"paused"}'

status musi być active, paused lub archived.

Wyślij prośbę o płatność e-mailem

MakeCrypto może wysłać hostowany link bezpośrednio na adres e-mail klienta w ładunku linku do płatności lub na zastępczą wiadomość e-mail w treści żądania.

curl

curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID/send-request-email" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"email":"buyer@example.com"}'

Wysyłać e-mailem można wyłącznie aktywne linki do płatności. Wypełnionych linków do płatności nie można wysłać ponownie.