Quickstart

import Pulse, { useApiKey } from '@pulsebyshiga/node';

const pulse = new Pulse(useApiKey(process.env.PULSE_API_KEY), {
  webhookSecret: process.env.PULSE_WEBHOOK_SECRET,
});

// USD gate — no user_ref, no account block; funds land in your omnibus.
const session = await pulse.collectionSessions.create(
  {
    gate: 'usd',
    target: { currency: 'USD', amount: '100.00' },
    asset: 'USDT',
    network: 'base',
  },
  { idempotencyKey: `fund-${depositId}` },
);

// Return only the token to your frontend — never the sk_ key.
return { session_token: session.session_token };

import { PulseCollectPayment } from '@pulsebyshiga/collect-react';

<PulseCollectPayment sessionToken={sessionToken} onSuccess={onFunded} />;

// Express — note express.raw: the raw body is required for the signature.
app.post('/webhooks/pulse', express.raw({ type: '*/*' }), async (req, res) => {
  const event = await pulse.webhooks.verifyOnce(req.body, req.header('pulse-signature') ?? '');
  if (event === null) return res.sendStatus(200); // duplicate — already processed

  switch (event.type) {
    case 'disbursement.completed':
      await creditPosition(event.data.order_id, event.data.disbursement.settlement_ref);
      break;
    case 'collection.amount.underpaid':
      await handleShortfall(event.data); // { expected, received, asset, network, tx_hash }
      break;
    case 'collection.deposit.wrong_chain':
      // funds arrived on the wrong network; the order is still payable on the right one
      await flagForSupport(event.data); // { order_id, deposit, expected_network }
      break;
  }
  res.sendStatus(200);
});

POST /sandbox/collection-orders/{order_id}/simulate
{ "event": "deposit_detected" }        # optional "received_amount" to force a mismatch
{ "event": "deposit_confirmed" }
{ "event": "disburse" }