Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.usepaykit.dev/llms.txt

Use this file to discover all available pages before exploring further.

No try/catch needed. Every method returns [data, error]: 
const [customer, error] = await paykit.customers.create({
  email: 'user@example.com',
  name: 'Jane Doe',
});

if (error) {
  console.error(error.message);
  return;
}

console.log(customer.id);

​
Error types

Import from @paykit-sdk/core: 
import {
  ValidationError,
  ConfigurationError,
  ProviderNotSupportedError,
  NotImplementedError,
} from '@paykit-sdk/core';
ErrorWhen
ValidationErrorInput fails schema validation
ConfigurationErrorProvider misconfigured or missing env vars
ProviderNotSupportedErrorOperation not supported by this provider
NotImplementedErrorOperation planned but not yet built

​
Example

const [checkout, error] = await paykit.checkouts.create({ ... });

if (error instanceof ValidationError) {
  return res.status(400).json({ error: error.message });
}

if (error instanceof ProviderNotSupportedError) {
  return res.status(501).json({ error: 'Not supported by this provider' });
}

if (error) {
  return res.status(500).json({ error: 'Unexpected error' });
}

redirect(checkout.payment_url);