Referensi API Pengembang Cryptorefills: Integrasi Checkout Stablecoin

1

Otentikasi

Setiap permintaan API memerlukan header ini. Setelah membuat akun Cryptorefills, Anda dapat menemukan ID Mitra Anda di halaman informasi akun Anda.

Buka halaman informasi akun Anda

bash

# Required headers for every API request
-H 'X-Cr-Application: YOUR_PARTNER_ID'
-H 'X-Cr-Version: YOUR_APP_VERSION'
-H 'X-Forwarded-For: END_USER_IP'
-H 'User-Agent: END_USER_AGENT'
-H 'Content-Type: application/json'

2

Metode pembayaran

GET/v3/payment_vias

Ambil semua koin dan jaringan blockchain yang didukung. Mengembalikan USDC, USDT di Solana, Ethereum, Base, Arbitrum, Polygon, dan lainnya.

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' \
  -H 'X-Forwarded-For: END_USER_IP' \
  -H 'User-Agent: END_USER_AGENT'

Direkomendasikan: USDC di Solana menawarkan biaya terendah dan penyelesaian tercepat.

3

Katalog merek

GET/v2/brands?country_code={countryCode}

(Opsional) Daftar semua merek yang tersedia untuk suatu negara. Bagus untuk membangun direktori merek atau fitur pencarian.

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' \
  -H 'X-Forwarded-For: END_USER_IP' \
  -H 'User-Agent: END_USER_AGENT'

Variasi URL Logo

Setiap merek mengembalikan logo_url (default) dan logo_base_url. Tambahkan akhiran ke logo_base_url untuk mengambil ukuran dan format yang dioptimalkan.

.webpDirekomendasikan

{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

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

Kode negara yang didukung

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

4

Umpan beranda

GET/v2/homepage?country_code={countryCode}

(Opsional) Ambil umpan beranda yang dikurasi untuk suatu negara. Berguna untuk menampilkan kartu hadiah yang sedang tren atau unggulan.

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' \
  -H 'X-Forwarded-For: END_USER_IP' \
  -H 'User-Agent: END_USER_AGENT'

5

Jelajahi produk

GET/v5/products/country/{countryCode}

Daftar semua kartu hadiah yang tersedia untuk suatu merek dan negara. Mendukung denominasi tetap dan jumlah kustom (rentang).

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' \
  -H 'X-Forwarded-For: END_USER_IP' \
  -H 'User-Agent: END_USER_AGENT'

6

Dapatkan harga kripto

GET/v4/products/price

Ubah nilai kartu hadiah apa pun menjadi jumlah stablecoin. Gunakan ini untuk menunjukkan kepada pengguna jumlah kripto yang tepat sebelum mereka mengonfirmasi pembelian.

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' \
  -H 'X-Forwarded-For: END_USER_IP' \
  -H 'User-Agent: END_USER_AGENT'

7

Validasi pesanan

POST/v5/orders/validations

(Disarankan) Periksa masalah sebelum membuat pesanan. Gunakan email pengguna akhir yang sebenarnya di email/beneficiary_account, karena Cryptorefills mengirimkan kepada penerima tersebut.

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' \
  -H 'X-Forwarded-For: END_USER_IP' \
  -H 'User-Agent: END_USER_AGENT' \
  -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"
      }
    ],
    "lang": "en"
  }'

Kesalahan yang mungkin terjadi

Respons mengembalikan array masalah. Setiap entri memiliki bentuk { masalah, moreDetails? }, dan beberapa masalah dapat dikembalikan sekaligus. Kesalahan HTTP tingkat atas (penangguhan) kembali sebagai { status, detail, moreDetails? } sebagai gantinya.

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.

Compliance & identity verification

KYC_MISSINGOne or more products require a verified account, or the user has exceeded the spending limit for unverified accounts. Direct the user to their Cryptorefills account to complete identity verification before retrying.
KYC_PENDINGIdentity verification is already in progress for this account. This typically completes within 20 minutes but may take up to 48 hours.
VERIFICATION_REQUIREDCryptorefills requires additional verification for this account before the order can proceed. Contact Cryptorefills support if this persists.

HTTP-level errors (top-level detail field)

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

8

Buat pesanan

POST/v5/orders

Buat pesanan dan terima alamat dompet untuk pembayaran. Gunakan email pengguna akhir yang sebenarnya karena Cryptorefills harus mengirimkan produk kepada penerima tersebut. Jendela pembayaran adalah 30 menit.

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' \
  -H 'X-Forwarded-For: END_USER_IP' \
  -H 'User-Agent: END_USER_AGENT' \
  -d '{
    "deliveries": [
      {
        "brand_name": "Airbnb",
        "country_code": "US",
        "denomination": "100 USD",
        "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"
    }
  }'

Range product example

For products with a flexible amount (e.g. open-value gift cards), set denomination to "range" and pass the desired value in product_value.

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' \
  -H 'X-Forwarded-For: END_USER_IP' \
  -H 'User-Agent: END_USER_AGENT' \
  -d '{
    "payment": {
      "payment_via": "USER_WALLET",
      "coin": "USDC",
      "type": "via",
      "network": "POLYGON (MATIC)"
    },
    "deliveries": [
      {
        "beneficiary_account": "END_USER_EMAIL",
        "brand_name": "Everything Apple",
        "country_code": "US",
        "denomination": "range",
        "product_value": 12
      }
    ],
    "lang": "en"
  }'

Akun penerima

Setiap pengiriman harus menyertakan sebuah beneficiary_account dalam barang yang dapat disampaikan, di situlah Cryptorefills mengirimkan produk. Format yang diperlukan tergantung pada jenis produk.

Kartu hadiah dan eSIM: gunakan alamat email pengguna akhir — misalnya user@example.com.
Pengisian ulang seluler: gunakan nomor telepon penerima dalam format E.164, termasuk + di depan dan kode negara — misalnya +14155551234.

Respon mencakup wallet_address and coin_amount. Bagikan ini dengan pengguna Anda.

9a

Lacak pesanan (API stream)

GET/api/orders/{orderId}/subscribe

Terapkan ini dalam dua bagian yang diperlukan: rute proxy SSE sisi server dan hook stream sisi klien.

Rute API menerima/api/orders/{orderId}/subscribe dan meneruskan ke hulu/v5/orders/{orderId}/subscribe.
Hook klien membukaEventSource ke rute API lokal, memvalidasi payload, dan menyambung kembali dengan backoff saat diperlukan.

Kode Esensial Sisi Server

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

Kode Esensial Sisi Klien

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

Rute di repositori ini

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

Sisi server (rute API)

Menggunakan header server berbasis sesi melaluigenHeader.server(session), kemudian memanggil hulu${process.env.API_URL}/v5/orders/${params?.orderId}/subscribe. Pada kegagalan koneksi, ia mengembalikan502.

Sisi klien (hook)

MembukaEventSource ke/api/orders/${referenceOrderId}/subscribe, memvalidasi setiap payload denganorderSchema.safeParse, menanganistop peristiwa, dan menyambung kembali dengan backoff eksponensial.

9b

Lacak pesanan (polling)

GET/v5/orders/{orderId}

Pendekatan cadangan: polling setiap 5-10 detik sampai pembayaran diterima. Kode kartu hadiah muncul ketika status adalah 'Selesai'.

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' \
  -H 'X-Forwarded-For: END_USER_IP' \
  -H 'User-Agent: END_USER_AGENT'

Gunakan polling ketika

Anda tidak dapat menjaga koneksi SSE tetap terbuka, atau lingkungan klien Anda tidak mendukung EventSource dengan andal.

Status pesanan yang umum

MenungguPembayaran -> MenungguPengiriman -> Selesai

Created: Order has been created but no payment activity yet. Initial state right after checkout.
WaitingForPayment: Order is awaiting the customer's crypto payment. The payment window is open and countdown is running.
PaymentStarted: Customer has initiated a payment (transaction broadcast) but it hasn't been confirmed/received yet.
PartialPaymentStarted: A partial payment has been detected — the customer paid less than the required amount.
PaymentReceived: Payment has been received and confirmed on-chain, but delivery hasn't started yet.
WaitingForDelivery: Payment is confirmed; the order is queued for delivery.
WaitingForManualAction: Order requires manual intervention by the team (e.g. verification, supplier issue, edge case).
Done: Order is fully completed and delivered to the customer. Terminal success state.
Expired: Payment window elapsed without a valid payment being received. Terminal state.
PaymentFailed: The payment attempt failed (e.g. on-chain failure, rejected transaction).
PaymentSetupFailed: The payment couldn't even be set up (e.g. provider/quote failure before the user could pay).
Refunded: Order was refunded to the customer.

Referensi API pengembang

Otentikasi

Metode pembayaran

Katalog merek

Umpan beranda

Jelajahi produk

Dapatkan harga kripto

Validasi pesanan

Kesalahan yang mungkin terjadi

Order amount & limits

Product availability

Payment method & network

Authentication

Coupon codes

Compliance & identity verification

HTTP-level errors (top-level detail field)

Buat pesanan

Akun penerima

Lacak pesanan (API stream)

Lacak pesanan (polling)