Referencia de API para desarrolladores de Cryptorefills: Integración de pago con stablecoin

1

Autenticación

Cada solicitud de API requiere estos encabezados. Después de crear una cuenta de Cryptorefills, puedes encontrar tu ID de socio en la página de información de tu cuenta.

Abrir la página de información de tu cuenta

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 pago

GET/v3/payment_vias

Obtén todas las monedas y redes blockchain soportadas. Devuelve USDC, USDT en Solana, Ethereum, Base, Arbitrum, Polygon y más.

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 en Solana ofrece las tarifas más bajas y la liquidación más rápida.

3

Catálogo de marcas

GET/v2/brands?country_code={countryCode}

(Opcional) Enumera todas las marcas disponibles para un país. Ideal para construir un directorio de marcas o características de búsqueda.

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 del logo

Cada marca devuelve un logo_url (predeterminado) y un logo_base_url. Agrega un sufijo a logo_base_url para obtener tamaños y formatos optimizados.

.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

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

Códigos de país soportados

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

4

Feed de la página de inicio

GET/v2/homepage?country_code={countryCode}

(Opcional) Obtén un feed curado para la página de inicio de un país. Útil para mostrar tarjetas de regalo en tendencia o destacadas.

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

Explorar productos

GET/v5/products/country/{countryCode}

Enumera todas las tarjetas de regalo disponibles para una marca y un país. Soporta denominaciones fijas y montos personalizados (rangos).

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

Obtener precio de criptomonedas

GET/v4/products/price

Convierte cualquier valor de tarjeta de regalo a un monto en stablecoin. Usa esto para mostrar a los usuarios el monto exacto en criptomonedas antes de que confirmen la 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) Verifica si hay problemas antes de crear el pedido. Usa el correo electrónico real del usuario final en email/beneficiary_account, ya que Cryptorefills entrega a ese destinatario.

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

Errores posibles

La respuesta devuelve un array de problemas. Cada entrada tiene la forma { problema, másDetalles? }, y se pueden devolver múltiples problemas a la vez. Los errores HTTP de nivel superior (suspensiones) se devuelven como { estado, detalle, másDetalles? } en su lugar.

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

Crear pedido

POST/v5/orders

Crea un pedido y recibe una dirección de billetera para el pago. Usa el correo electrónico real del usuario final porque Cryptorefills debe entregar el producto a ese destinatario. La ventana de pago es 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"
    }
  }'

Cuenta del beneficiario

Cada entrega debe incluir un beneficiary_account en su entregable, ahí es donde Cryptorefills entrega el producto. El formato requerido depende del tipo de producto.

Tarjetas de regalo y eSIMs: usa la dirección de correo electrónico del usuario final — por ejemplo user@example.com.
Recargas móviles: usa el número de teléfono del destinatario en formato E.164, incluyendo el + inicial y el código del país — por ejemplo +14155551234.

La respuesta incluye wallet_address and coin_amount. Comparte esto con tu usuario.

9a

Rastrear pedido (API de stream)

GET/api/orders/{orderId}/subscribe

Implementa esto en dos piezas requeridas: una ruta de proxy SSE del lado del servidor y un hook de stream del lado del cliente.

La ruta de la API recibe/api/orders/{orderId}/subscribe y reenvía a upstream/v5/orders/{orderId}/subscribe.
El hook del cliente abreEventSource a la ruta de la API local, valida las cargas útiles y se reconecta con retroceso cuando sea necesario.

Código Esencial del Lado del 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 Esencial del Lado del 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>,
);

Ruta en este repositorio

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

Lado del servidor (ruta de API)

Usa encabezados de servidor basados en sesión a través degenHeader.server(session), luego llama a upstream${process.env.API_URL}/v5/orders/${params?.orderId}/subscribe. En caso de fallo de conexión, devuelve502.

Lado del cliente (hook)

AbreEventSource a/api/orders/${referenceOrderId}/subscribe, valida cada carga útil conorderSchema.safeParse, manejastop eventos y se reconecta con retroceso exponencial.

9b

Rastrear pedido (polling)

GET/v5/orders/{orderId}

Enfoque de respaldo: consulta cada 5-10 segundos hasta que se reciba el pago. El código de la tarjeta de regalo aparece cuando el estado es 'Hecho'.

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'

Usa polling cuando

No puedes mantener una conexión SSE abierta, o tu entorno cliente no soporta EventSource de manera confiable.

Estados típicos del pedido

WaitingForPayment -> WaitingForDelivery -> Done