API Saklaw

Developer API reference

Production-focused cURL at Node examples para sa stablecoin checkout, paglikha ng order, at pagsubaybay sa paghahatid.

Sakop sa gabay na ito

  • Mga gift card
  • Mga mobile top-up
  • Mga eSIM na pagbili

Hindi sakop dito

  • Mga flight
  • Mga stay

Kailangan ang mas malawak na konteksto ng integrasyon bago sumisid sa mga endpoint?

Buksan ang pangkalahatang-ideya ng integrasyon
1

Authentication

Bawat API request ay nangangailangan ng mga headers na ito. Matapos lumikha ng Cryptorefills account, makikita mo ang iyong Partner ID sa iyong pahina ng impormasyon ng account.
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

Mga paraan ng pagbabayad

GET/v3/payment_vias
Kunin ang lahat ng suportadong coin at blockchain networks. Nagbabalik ng USDC, USDT sa Solana, Ethereum, Base, Arbitrum, Polygon, at iba pa.
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'

Inirerekomenda: Ang USDC sa Solana ay nag-aalok ng pinakamababang bayarin at pinakamabilis na settlement.

3

Katalog ng tatak

GET/v2/brands?country_code={countryCode}
(Opsyonal) Ilista ang lahat ng magagamit na tatak para sa isang bansa. Magandang gamitin para sa pagbuo ng direktoryo ng tatak o mga tampok sa paghahanap.
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'
4

Feed ng homepage

GET/v2/homepage?country_code={countryCode}
(Opsyonal) Kunin ang isang curated na feed ng homepage para sa isang bansa. Kapaki-pakinabang para sa pagpapakita ng mga trending o tampok na gift card.
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

Mag-browse ng mga produkto

GET/v5/products/country/{countryCode}
Ilista ang lahat ng magagamit na gift card para sa isang tatak at bansa. Sinusuportahan ang mga nakatakdang denominasyon at mga pasadyang halaga (mga saklaw).
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

Kunin ang presyo ng crypto

GET/v4/products/price
I-convert ang anumang halaga ng gift card sa halaga ng stablecoin. Gamitin ito upang ipakita sa mga gumagamit ang eksaktong halaga ng crypto bago nila kumpirmahin ang pagbili.
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

I-validate ang order

POST/v5/orders/validations
(Inirerekomenda) Suriin ang mga isyu bago lumikha ng order. Gamitin ang tunay na email ng end-user sa email/beneficiary_account, dahil ang Cryptorefills ay nagdadala sa tatanggap na iyon.
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"
  }'
8

Lumikha ng order

POST/v5/orders
Lumikha ng isang order at tumanggap ng wallet address para sa pagbabayad. Gamitin ang tunay na email ng end-user dahil ang Cryptorefills ay dapat maghatid ng produkto sa tatanggap na iyon. Ang bintana ng pagbabayad ay 30 minuto.
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"
        }
      }
    ],
    "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"
    }
  }'

Kasama sa tugon wallet_address and coin_amount. Ibahagi ang mga ito sa iyong gumagamit.

9a

Subaybayan ang order (stream API)

GET/api/orders/{orderId}/subscribe
Ipatupad ito sa dalawang kinakailangang bahagi: isang server-side SSE proxy route at isang client-side stream hook.
  • Tumatanggap ang API route ng/api/orders/{orderId}/subscribe at ipinapasa sa upstream/v5/orders/{orderId}/subscribe.
  • Binubuksan ng Client hook angEventSource sa lokal na API route, sinisiyasat ang mga payload, at muling kumokonekta na may backoff kapag kinakailangan.

Mahalagang Code sa Server-Side

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',
  },
});

Mahalagang Code sa Client-Side

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 sa repo na ito

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

Server side (API route)

Gumagamit ng session-based server headers sa pamamagitan nggenHeader.server(session), pagkatapos ay tumatawag sa upstream${process.env.API_URL}/v5/orders/${params?.orderId}/subscribe. Sa pagkabigo ng koneksyon, nagbabalik ito ng502.

Client side (hook)

BinubuksanEventSource sa/api/orders/${referenceOrderId}/subscribe, sinasala ang bawat payload gamit angorderSchema.safeParse, hinahawakan angstop mga kaganapan, at muling kumokonekta na may exponential backoff.

9b

Subaybayan ang order (polling)

GET/v5/orders/{orderId}
Fallback na diskarte: mag-poll tuwing 5-10 segundo hanggang matanggap ang pagbabayad. Lumalabas ang gift card code kapag ang katayuan ay 'Tapos na'.
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'

Gamitin ang polling kapag

Hindi mo maiiwan ang isang SSE na koneksyon na bukas, o ang iyong client environment ay hindi maaasahang sumusuporta sa EventSource.

Karaniwang estado ng order

WaitingForPayment -> WaitingForDelivery -> Tapos na