Orders

Look up ground truth on a collection order — retrieve, list, and re-lock an expired quote.

The session you mint with collectionSessions.create returns an order_id. Use pulse.collectionOrders to check ground truth on that order at any point — independent of, or alongside, the webhooks you receive for it.

// Retrieve a single order
const order = await pulse.collectionOrders.retrieve(orderId);

// List orders, filtered by gate, status, and/or your own user_ref
const orders = await pulse.collectionOrders.list({
  gate: 'naira',
  status: 'awaiting_payment',
  user_ref: 'your_user_123',
});

// Re-lock an expired quote on an existing order (does not create a new order)
const refreshed = await pulse.collectionOrders.refreshQuote(orderId);

• retrieve(orderId) — fetch the current state of one order: deposit_address, qr_payload, quote, status, amount_status, deposit, and disbursement.
• list({ gate, status, user_ref }) — page through your orders, filtered by fiat gate, status, or the user_ref you supplied at session creation.
• refreshQuote(orderId) — when an order’s quote expires, re-lock it on the same order rather than creating a new one.

These calls are ground truth, not a replacement for webhooks. Drive your UI from either, but only credit a customer from a verified disbursement.completed event — see Webhooks.