kyshi.transactions creates and inspects one-time collections. For when to use each flow, see the Transactions guide.

Methods

Hosted Checkout

const checkout = await kyshi.transactions.initialize({
  email: '[email protected]',
  amount: 1000,
  localCurrency: 'NGN',
  amountCurrency: 'local',
  reference: 'ORDER-10001',
  redirectUrl: 'https://merchant.example.com/payments/callback',
});

console.log(checkout.authorizationUrl);

Be deliberate about amountCurrency. It defaults to settlement, so sending 1000 meaning Naira while relying on the default charges roughly 1500× too much. See Countries And Currencies.

Bank Transfer Charge

const charge = await kyshi.transactions.charge({
  email: '[email protected]',
  amount: 5000,
  localCurrency: 'NGN',
  amountCurrency: 'local',
  reference: 'ORDER-10002',
  chargeType: 'BANK_TRANSFER',
});

The customer types the amount themselves, so underpayment and overpayment are possible. See Virtual Accounts.

Verify Before Giving Value

const transaction = await kyshi.transactions.verify('ORDER-10001');

if (transaction.status === 'SUCCESS') {
  await fulfilOnce('ORDER-10001');   // idempotent
}

This is the only signal you should release goods on. The checkout redirect is a UI event, not proof of payment.

Note transaction.status is the transaction state (SUCCESS, PENDING, FAILED, IN_REVIEW, REVERSAL, COLLECTED) — not a boolean. See Statuses And Lifecycles.

Reconcile

const history = await kyshi.transactions.list({ page: 1, limit: 50 });
const one = await kyshi.transactions.retrieve('transaction-id');

Filter to a closed time range when reconciling. The default order is newest first, so paging through live data can shift rows between pages.

Next

• Transactions guide — flows, failure handling, reconciliation
• Configuration — retries and idempotency