Cryptorefills Entwickler-API-Referenz: Stablecoin-Checkout-Integration

1

Authentifizierung

Jede API-Anfrage erfordert diese Header. Nach der Erstellung eines Cryptorefills-Kontos finden Sie Ihre Partner-ID auf Ihrer Kontoinformationsseite.

Öffnen Sie Ihre Kontoinformationsseite

bash

# Required headers for every API request
-H 'X-Cr-Application: YOUR_PARTNER_ID'
-H 'X-Cr-Version: YOUR_APP_VERSION'
-H 'X-Country-ISO-Code: US'
-H 'Content-Type: application/json'

2

Zahlungsmethoden

GET/v3/payment_vias

Rufen Sie alle unterstützten Coins und Blockchain-Netzwerke ab. Gibt USDC, USDT auf Solana, Ethereum, Base, Arbitrum, Polygon und mehr zurück.

bash

curl -X GET 'https://api.cryptorefills.com/v3/payment_vias' \
  -H 'Content-Type: application/json' \
  -H 'X-Cr-Application: YOUR_PARTNER_ID' \
  -H 'X-Cr-Version: YOUR_APP_VERSION'

Empfohlen: USDC auf Solana bietet die niedrigsten Gebühren und die schnellste Abwicklung.

3

Markenkatalog

GET/v2/brands?country_code={countryCode}

(Optional) Listet alle verfügbaren Marken für ein Land auf. Ideal für den Aufbau eines Markeverzeichnisses oder von Suchfunktionen.

bash

curl -X GET 'https://api.cryptorefills.com/v2/brands?country_code=US' \
  -H 'Content-Type: application/json' \
  -H 'X-Cr-Application: YOUR_PARTNER_ID' \
  -H 'X-Cr-Version: YOUR_APP_VERSION'

Logo-URL-Varianten

Jede Marke gibt eine logo_url (Standard) und eine logo_base_url zurück. Fügen Sie ein Suffix zu logo_base_url hinzu, um optimierte Größen und Formate abzurufen.

.webpEmpfohlen

{logo_base_url}.webp
{logo_base_url}_500x318.webp
{logo_base_url}_300x190.webp

.jpg

{logo_base_url}.jpg
{logo_base_url}_500x318.jpg
{logo_base_url}_300x190.jpg

Beispiel: https://cdn.cryptorefills.com/logos_v2/esim_500x318.webp

Unterstützte Ländercodes

233GET https://cryptorefills.com/api/available-countries

4

Startseiten-Feed

GET/v2/homepage?country_code={countryCode}

(Optional) Holt einen kuratierten Startseiten-Feed für ein Land. Nützlich zum Anzeigen von trendigen oder hervorgehobenen Geschenkkarten.

bash

curl -X GET 'https://api.cryptorefills.com/v2/homepage?country_code=US' \
  -H 'Content-Type: application/json' \
  -H 'X-Cr-Application: YOUR_PARTNER_ID' \
  -H 'X-Cr-Version: YOUR_APP_VERSION'

5

Produkte durchsuchen

GET/v5/products/country/{countryCode}

Listet alle verfügbaren Geschenkkarten für eine Marke und ein Land auf. Unterstützt feste Beträge und benutzerdefinierte Beträge (Bereiche).

bash

curl -X GET 'https://api.cryptorefills.com/v5/products/country/US?family_name=airbnb&coin=USDC&lang=en' \
  -H 'Content-Type: application/json' \
  -H 'X-Cr-Application: YOUR_PARTNER_ID' \
  -H 'X-Cr-Version: YOUR_APP_VERSION'

6

Krypto-Preis abrufen

GET/v4/products/price

Konvertiert jeden Geschenkkartenwert in einen Stablecoin-Betrag. Verwenden Sie dies, um den Benutzern den genauen Krypto-Betrag anzuzeigen, bevor sie den Kauf bestätigen.

bash

curl -X GET 'https://api.cryptorefills.com/v4/products/price?brand_name=Airbnb&country_code=US&face_value=100&coin=USDC' \
  -H 'Content-Type: application/json' \
  -H 'X-Cr-Application: YOUR_PARTNER_ID' \
  -H 'X-Cr-Version: YOUR_APP_VERSION'

7

Bestellung validieren

POST/v5/orders/validations

(Empfohlen) Überprüfen Sie auf Probleme, bevor Sie die Bestellung erstellen. Verwenden Sie die echte E-Mail des Endbenutzers in email/beneficiary_account, da Cryptorefills an diesen Empfänger liefert.

bash

curl -X POST 'https://api.cryptorefills.com/v5/orders/validations' \
  -H 'Content-Type: application/json' \
  -H 'X-Cr-Application: YOUR_PARTNER_ID' \
  -H 'X-Cr-Version: YOUR_APP_VERSION' \
  -d '{
    "email": "END_USER_EMAIL",
    "payment": {
      "type": "via",
      "payment_via": "USER_WALLET",
      "coin": "USDC"
    },
    "deliveries": [
      {
        "beneficiary_account": "END_USER_EMAIL",
        "brand_name": "Airbnb",
        "country_code": "US",
        "denomination": "100 USD",
        "localized_denomination": "$100"
      }
    ],
    "lang": "en"
  }'

Mögliche Fehler

Die Antwort enthält ein Array von Problemen. Jedes Element hat die Form { problem, moreDetails? }, und mehrere Probleme können gleichzeitig zurückgegeben werden. Top-Level-HTTP-Fehler (Sperrungen) werden stattdessen als { status, detail, moreDetails? } zurückgegeben.

Order amount & limits

AMOUNT_LESS_THEN_MINIMUM_ALLOWEDOrder total is below the minimum coin amount allowed.
MAXIMUM_AMOUNT_PER_ORDER_EXCEEDEDOrder total exceeds the per-order maximum.
DAILY_SPENDING_LIMIT_EXCEEDEDUser has hit the daily spending limit for their tier.
MONTHLY_SPENDING_LIMIT_EXCEEDEDUser has hit the monthly spending limit for their tier.
PRODUCT_COUNT_EXCEEDEDCart contains more products than the per-order maximum.
MULTIPLE_LIMITED_PRODUCT_SAME_ORDEROrder contains more than one rate-limited product.

Product availability

NOT_AVAILABLE_PRODUCTProduct is no longer in the catalogue.
OUT_OF_STOCKProduct is currently out of stock.
NOT_ACTIVEProduct is inactive or paused.
INVALID_BENEFICIARY_ACCOUNTBeneficiary account is invalid — e.g. phone number for a mobile topup or email for a gift card.

Payment method & network

NOT_ALLOWED_PAYMENT_VIASelected payment_via is not allowed for this order. moreDetails lists allowed kinds.
UNSUPPORTED_PROTOCOL_COIN_COMBINATIONChosen protocol + coin pair is not supported. moreDetails lists supported combinations.

Authentication

LOGIN_REQUIREDOne or more products require a signed-in user.
COUPON_REQUIRES_LOGINThe coupon can only be redeemed by a signed-in user.

Coupon codes

COUPON_NOT_FOUNDCoupon code does not exist.
COUPON_NOT_ACTIVECoupon is not yet active.
COUPON_ALREADY_SPENTCoupon has already been redeemed by this user.
COUPON_MAX_USAGE_REACHEDCoupon has reached its overall usage cap.
COUPON_EXPIREDCoupon is past its validity date.
COUPON_BELOW_MIN_AMOUNTOrder total is below the coupon’s minimum amount.
COUPON_NOT_VALID_FOR_USERCoupon is not valid for this user.
COUPON_NOT_VALID_FOR_CATEGORYCoupon does not apply to the selected product categories.
COUPON_NOT_VALID_FOR_KINDCoupon does not apply to the selected product kind.
COUPON_NOT_VALID_FOR_BRANDCoupon does not apply to the selected brands.
COUPON_NOT_VALID_FOR_COUNTRYCoupon is not valid in the order country.
COUPON_NOT_VALID_FOR_STORECoupon is not valid for the requested store or region.

HTTP-level errors (top-level detail field)

SUSPENDED_COINThe selected coin is temporarily suspended.
SUSPENDED_NETWORKThe selected network is temporarily suspended.

8

Bestellung erstellen

POST/v5/orders

Erstellen Sie eine Bestellung und erhalten Sie eine Wallet-Adresse für die Zahlung. Verwenden Sie die echte E-Mail des Endbenutzers, da Cryptorefills das Produkt an diesen Empfänger liefern muss. Das Zahlungsfenster beträgt 30 Minuten.

bash

curl -X POST 'https://api.cryptorefills.com/v5/orders' \
  -H 'Content-Type: application/json' \
  -H 'X-Cr-Application: YOUR_PARTNER_ID' \
  -H 'X-Cr-Version: YOUR_APP_VERSION' \
  -d '{
    "deliveries": [
      {
        "kind": "giftcard",
        "quantity": 1,
        "deliverable": {
          "brand_name": "Airbnb",
          "country_code": "US",
          "denomination": "100",
          "beneficiary_account": "END_USER_EMAIL"
        }
      }
    ],
    "payment": {
      "type": "via",
      "coin": "USDC",
      "network": "Solana",
      "payment_via": "USER_WALLET"
    },
    "user": {
      "email": "END_USER_EMAIL",
      "has_accepted_newsletter": true
    },
    "lang": "en",
    "acquisition": {
      "utm_source": "your_platform"
    }
  }'

Begünstigtenkonto

Jede Lieferung muss ein beneficiary_account in ihrem Liefergegenstand enthalten, wo Cryptorefills das Produkt liefert. Das erforderliche Format hängt von der Art des Produkts ab.

Geschenkkarten und eSIMs: verwenden Sie die E-Mail-Adresse des Endbenutzers — zum Beispiel user@example.com.
Mobile Aufladungen: verwenden Sie die Telefonnummer des Empfängers im E.164-Format, einschließlich des führenden + und der Landesvorwahl — zum Beispiel +14155551234.

Antwort enthält wallet_address and coin_amount. Teilen Sie dies mit Ihrem Benutzer.

9a

Bestellung verfolgen (Stream-API)

GET/api/orders/{orderId}/subscribe

Implementieren Sie dies in zwei erforderlichen Teilen: einer serverseitigen SSE-Proxy-Route und einem clientseitigen Stream-Hook.

API-Route empfängt/api/orders/{orderId}/subscribe und leitet an upstream weiter/v5/orders/{orderId}/subscribe.
Client-Hook öffnetEventSource zur lokalen API-Route, validiert Payloads und stellt bei Bedarf mit Backoff die Verbindung wieder her.

Serverseitiger Essentieller Code

javascript

// app/api/orders/[orderId]/subscribe/route.ts
let upstream: Response;

try {
  upstream = await fetch(
    `https://api.cryptorefills.com/v5/orders/${params?.orderId}/subscribe`,
    {
      method: 'GET',
      headers: {
        ...(await genHeader.server(session)),
        'User-Agent': user_agent,
        Accept: 'text/event-stream',
        Connection: 'keep-alive',
      },
    },
  );
} catch (err) {
  return NextResponse.json(
    { error: 'Failed to connect to upstream stream' },
    { status: 502 },
  );
}

if (!upstream.ok || !upstream.body) {
  return NextResponse.json(
    { error: 'Upstream returned an error' },
    { status: upstream.status || 502 },
  );
}

// stream = ReadableStream that proxies upstream SSE events
return new Response(stream, {
  status: 200,
  headers: {
    'Content-Type': 'text/event-stream',
    'Cache-Control': 'no-cache, no-transform',
    Connection: 'keep-alive',
    'X-Accel-Buffering': 'no',
  },
});

Clientseitiger Essentieller Code

javascript


const { data: lastEvent, error } = useSWRSubscription<TOrderSchema>(
  referenceOrderId ? `orders-info-stream-${referenceOrderId}` : null,
  ((key, { next }) => {
    let es: EventSource | null = null;
    let stopped = false;
    let shouldReconnect = true;
    let retryTimeout: number | null = null;
    let retryDelay = 1000;

    const cleanup = () => {
      if (es) {
        es.close();
        es = null;
      }
      if (retryTimeout !== null) {
        window.clearTimeout(retryTimeout);
        retryTimeout = null;
      }
    };

    const stopForever = () => {
      shouldReconnect = false;
      stopped = true;
      cleanup();
    };

    const connect = () => {
      if (stopped) return;
      cleanup();
      es = new EventSource(`/api/orders/${referenceOrderId}/subscribe`);

      es.addEventListener('message', (ev) => {
        try {
          const raw = JSON.parse(ev.data);
          const parsed = orderSchema.safeParse(raw);
          if (!parsed.success) return;
          retryDelay = 1000;
          next(null, parsed.data as TOrderSchema);
        } catch (err) {
          next(err as Error);
        }
      });

      es.addEventListener('stop', () => {
        stopForever();
      });

      es.onerror = () => {
        if (stopped || !shouldReconnect) return;
        cleanup();
        retryTimeout = window.setTimeout(() => {
          retryDelay = Math.min(retryDelay * 2, 30000);
          connect();
        }, retryDelay);
      };
    };

    connect();

    return () => {
      stopped = true;
      cleanup();
    };
  }) as SubscriptionCallback<TOrderSchema>,
);

Route in diesem Repo

app/api/orders/[orderId]/subscribe/route.ts

Serverseite (API-Route)

Verwendet sitzungsbasierte Server-Header übergenHeader.server(session), ruft dann upstream auf${process.env.API_URL}/v5/orders/${params?.orderId}/subscribe. Bei Verbindungsfehler gibt es zurück502.

Clientseite (Hook)

ÖffnetEventSource zu/api/orders/${referenceOrderId}/subscribe, validiert jedes Payload mitorderSchema.safeParse, behandeltstop Ereignisse und stellt mit exponentiellem Backoff die Verbindung wieder her.

9b

Bestellung verfolgen (Polling)

GET/v5/orders/{orderId}

Fallback-Ansatz: alle 5-10 Sekunden abfragen, bis die Zahlung eingegangen ist. Der Geschenkkarten-Code erscheint, wenn der Status 'Fertig' ist.

bash

curl -X GET 'https://api.cryptorefills.com/v5/orders/ord_abc123xyz' \
  -H 'Content-Type: application/json' \
  -H 'X-Cr-Application: YOUR_PARTNER_ID' \
  -H 'X-Cr-Version: YOUR_APP_VERSION'

Polling verwenden, wenn

Sie können eine SSE-Verbindung nicht offen halten oder Ihre Client-Umgebung unterstützt EventSource nicht zuverlässig.

Typische Bestellzustände

WaitingForPayment -> WaitingForDelivery -> Done