@reevit/svelte

Svelte SDK for integrating Reevit unified payments into your application.

Installation

npm install @reevit/svelte @reevit/core

Quick Start

The simplest way to integrate Reevit is using the ReevitCheckout component.

<script lang="ts">
  import { ReevitCheckout } from '@reevit/svelte';
  import '@reevit/svelte/styles.css';

  const handleSuccess = (event) => {
    console.log('Payment success!', event.detail);
  };

  const handleError = (event) => {
    console.error('Payment failed:', event.detail);
  };
</script>

<ReevitCheckout
  publicKey="pk_test_xxx"
  amount={10000}
  currency="GHS"
  email="[email protected]"
  idempotencyKey="order_12345"
  on:success={handleSuccess}
  on:error={handleError}
>
  <button slot="default" let:handleOpen let:isLoading on:click={handleOpen} disabled={isLoading}>
    {isLoading ? 'Loading...' : 'Pay GHS 100.00'}
  </button>
</ReevitCheckout>

Idempotency

Provide an idempotencyKey tied to your order/cart to avoid duplicate intent creation and enable safe retries.

<ReevitCheckout
  publicKey="pk_test_xxx"
  amount={10000}
  currency="GHS"
  idempotencyKey="order_12345"
/>

Controlled Modal

You can control the open state yourself.

<script>
  let open = false;
</script>

<ReevitCheckout
  publicKey="pk_test_your_key"
  amount={10000}
  currency="GHS"
  bind:isOpen={open}
  on:close={() => open = false}
/>

Success Screen Delay

By default, the checkout shows a success screen for 5 seconds before calling on:success and closing. Override with successDelayMs (set to 0 for immediate close).

<ReevitCheckout successDelayMs={0} />

Custom Theme

<ReevitCheckout
  theme={{
    primaryColor: '#FF3E00',
    backgroundColor: '#FFFFFF',
    borderRadius: '10px'
  }}
  publicKey="pk_test_xxx"
  amount={5000}
  currency="GHS"
>
  <button on:click={handleOpen}>Secure Pay</button>
</ReevitCheckout>

Advanced Usage: createReevitStore

For full control over the payment flow, use the createReevitStore factory.

<script lang="ts">
  import { createReevitStore } from '@reevit/svelte';

  const store = createReevitStore({
    config: {
      publicKey: 'pk_test_xxx',
      amount: 5000,
      currency: 'GHS',
    },
    onSuccess: (res) => console.log('Payment done!', res),
  });

  $: state = $store;
</script>

<button on:click={() => store.initialize()}>Start Payment</button>

{#if state.status === 'ready'}
  <button on:click={() => store.selectMethod('card')}>Card</button>
  <button on:click={() => store.selectMethod('mobile_money')}>Mobile Money</button>
{/if}

Props Reference

| Prop | Type | Description | |------|------|-------------| | publicKey | string | Your project's public key (required for API-created intents; optional when using paymentLinkCode) | | amount | number | Required. Amount in the smallest unit (e.g., 500 for 5.00) | | currency | string | Required. 3-letter ISO currency code (GHS, NGN, USD, etc.) | | email | string | Customer's email address | | phone | string | Customer's phone number (recommended for Mobile Money) | | customerName | string | Customer name (used in payment links and some PSPs) | | reference | string | Your own unique transaction reference | | idempotencyKey | string | Optional idempotency key to safely retry or dedupe intent creation | | metadata | object | Key-value pairs to store with the transaction | | customFields | object | Custom fields for payment links | | paymentLinkCode | string | Hosted payment link code (uses the public link checkout flow) | | paymentMethods | PaymentMethod[] | Enabled methods: card, mobile_money, bank_transfer, apple_pay, google_pay (PSP/country dependent) | | initialPaymentIntent | PaymentIntent | Use an existing intent instead of creating a new one | | isOpen | boolean | Controlled open state | | theme | ReevitTheme | Customization options for the widget | | apiBaseUrl | string | Override API base URL (self-hosted/testing) | | successDelayMs | number | Delay before calling on:success and closing (default 5000) |

Theme Reference

| Field | Description | |-------|-------------| | primaryColor | Primary text/brand color | | primaryForegroundColor | Text color on primary brand surfaces | | backgroundColor | Background color for the modal | | borderColor | Border and divider color | | borderRadius | Border radius for inputs and buttons | | darkMode | Force dark mode when true | | logoUrl | Logo URL shown in the header | | companyName | Brand name shown in the header | | selectedBackgroundColor | Background color for selected provider/methods | | selectedTextColor | Primary text color for selected items | | selectedDescriptionColor | Description/muted text color for selected items | | selectedBorderColor | Border color for selected items | | pspSelectorBgColor | PSP selector background color (where supported) | | pspSelectorTextColor | PSP selector text color (where supported) | | pspSelectorBorderColor | PSP selector border color (where supported) | | pspSelectorUseBorder | Use border-only PSP selector styling |

Events

• on:success - CustomEvent<PaymentResult>
• on:error - CustomEvent<PaymentError>
• on:close - CustomEvent<void>

PSP Bridge Functions

For advanced use cases, you can use PSP bridge functions directly.

Stripe

import { createStripeInstance, confirmStripePayment } from '@reevit/svelte';

const stripe = await createStripeInstance('pk_test_xxx');
const elements = stripe.elements({ clientSecret: 'pi_xxx_secret_xxx' });
const paymentElement = elements.create('payment');
paymentElement.mount('#payment-element');

// Later, confirm payment
await confirmStripePayment({
  publishableKey: 'pk_test_xxx',
  clientSecret: 'pi_xxx_secret_xxx',
  elements,
  onSuccess: (result) => console.log('Paid:', result.paymentIntentId),
  onError: (err) => console.error(err.message),
});

Monnify (Nigeria)

import { openMonnifyModal } from '@reevit/svelte';

await openMonnifyModal({
  apiKey: 'MK_TEST_xxx',
  contractCode: '1234567890',
  amount: 5000,
  currency: 'NGN',
  reference: 'TXN_12345',
  customerName: 'John Doe',
  customerEmail: '[email protected]',
  onSuccess: (result) => console.log('Paid:', result.transactionReference),
  onClose: () => console.log('Closed'),
});

M-Pesa (Kenya/Tanzania)

import { initiateMPesaSTKPush } from '@reevit/svelte';

const result = await initiateMPesaSTKPush(
  {
    phoneNumber: '254712345678',
    amount: 500,
    reference: 'TXN_12345',
    onInitiated: () => console.log('STK Push sent'),
    onSuccess: (result) => console.log('Paid:', result.transactionId),
    onError: (err) => console.error(err.message),
  },
  '/api/mpesa/stk-push'
);

Supported PSPs

| Provider | Countries | Payment Methods | |----------|-----------|-----------------| | Paystack | NG, GH, ZA, KE | Card, Mobile Money, Bank Transfer | | Flutterwave | NG, GH, KE, ZA + | Card, Mobile Money, Bank Transfer | | Hubtel | GH | Mobile Money | | Stripe | Global (50+) | Card, Apple Pay, Google Pay | | Monnify | NG | Card, Bank Transfer, USSD | | M-Pesa | KE, TZ | Mobile Money (STK Push) |

Release Notes

v0.7.0

• Updated @reevit/core dependency to v0.7.0
• Version alignment across all Reevit SDKs

License

MIT © Reevit