Referência da API do Desenvolvedor Cryptorefills: Integração de Checkout com Stablecoin

1

Autenticação

Cada solicitação da API requer esses cabeçalhos. Após criar uma conta no Cryptorefills, você pode encontrar seu ID de parceiro na página de informações da sua conta.

Abra sua página de informações da conta

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

Métodos de pagamento

GET/v3/payment_vias

Busque todas as moedas e redes blockchain suportadas. Retorna USDC, USDT na Solana, Ethereum, Base, Arbitrum, Polygon e mais.

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'

Recomendado: USDC na Solana oferece as taxas mais baixas e a liquidação mais rápida.

3

Catálogo de marcas

GET/v2/brands?country_code={countryCode}

(Opcional) Liste todas as marcas disponíveis para um país. Ótimo para construir um diretório de marcas ou recursos de busca.

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'

Variantes de URL do Logo

Cada marca retorna um logo_url (padrão) e um logo_base_url. Anexe um sufixo ao logo_base_url para buscar tamanhos e formatos otimizados.

.webpRecomendado

{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

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

Códigos de país suportados

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

4

Feed da página inicial

GET/v2/homepage?country_code={countryCode}

(Opcional) Busque um feed da página inicial curado para um país. Útil para exibir cartões-presente em alta ou em destaque.

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

Navegar por produtos

GET/v5/products/country/{countryCode}

Liste todos os cartões-presente disponíveis para uma marca e país. Suporta denominações fixas e valores personalizados (intervalos).

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

Obter preço de criptomoeda

GET/v4/products/price

Converta qualquer valor de cartão-presente em um valor de stablecoin. Use isso para mostrar aos usuários o valor exato em criptomoeda antes de confirmarem a compra.

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

Validar pedido

POST/v5/orders/validations

(Recomendado) Verifique se há problemas antes de criar o pedido. Use o e-mail real do usuário final em email/beneficiary_account, já que a Cryptorefills entrega ao destinatário.

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

Possíveis erros

A resposta retorna um array de problemas. Cada entrada tem a forma { problema, maisDetalhes? }, e múltiplos problemas podem ser retornados de uma vez. Erros HTTP de nível superior (suspensões) retornam como { status, detalhe, maisDetalhes? } em vez disso.

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

Criar pedido

POST/v5/orders

Crie um pedido e receba um endereço de carteira para pagamento. Use o e-mail real do usuário final porque a Cryptorefills deve entregar o produto a esse destinatário. A janela de pagamento é de 30 minutos.

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

Conta do beneficiário

Cada entrega deve incluir um beneficiary_account em seu entregável, é onde a Cryptorefills entrega o produto. O formato requerido depende do tipo de produto.

Cartões-presente e eSIMs: use o endereço de e-mail do usuário final — por exemplo user@example.com.
Recargas móveis: use o número de telefone do destinatário no formato E.164, incluindo o + inicial e o código do país — por exemplo +14155551234.

A resposta inclui wallet_address and coin_amount. Compartilhe isso com seu usuário.

9a

Rastrear pedido (API de stream)

GET/api/orders/{orderId}/subscribe

Implemente isso em duas partes obrigatórias: uma rota de proxy SSE do lado do servidor e um hook de stream do lado do cliente.

A rota da API recebe/api/orders/{orderId}/subscribe e encaminha para o upstream/v5/orders/{orderId}/subscribe.
O hook do cliente abreEventSource para a rota da API local, valida os payloads e reconecta com backoff quando necessário.

Código Essencial do Lado do Servidor

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

Código Essencial do Lado do Cliente

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

Rota neste repositório

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

Lado do servidor (rota da API)

Usa cabeçalhos de servidor baseados em sessão viagenHeader.server(session), então chama o upstream${process.env.API_URL}/v5/orders/${params?.orderId}/subscribe. Em caso de falha de conexão, retorna502.

Lado do cliente (hook)

AbreEventSource para/api/orders/${referenceOrderId}/subscribe, valida cada payload comorderSchema.safeParse, manipulastop eventos e reconecta com backoff exponencial.

9b

Rastrear pedido (polling)

GET/v5/orders/{orderId}

Abordagem de fallback: faça polling a cada 5-10 segundos até que o pagamento seja recebido. O código do cartão-presente aparece quando o status é 'Concluído'.

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'

Use polling quando

Você não pode manter uma conexão SSE aberta, ou seu ambiente cliente não suporta EventSource de forma confiável.

Estados típicos do pedido

AguardandoPagamento -> AguardandoEntrega -> Concluído

Referência da API do desenvolvedor

Autenticação

Métodos de pagamento

Catálogo de marcas

Feed da página inicial

Navegar por produtos

Obter preço de criptomoeda

Validar pedido

Possíveis erros

Order amount & limits

Product availability

Payment method & network

Authentication

Coupon codes

HTTP-level errors (top-level detail field)

Criar pedido

Conta do beneficiário

Rastrear pedido (API de stream)

Rastrear pedido (polling)