API Reference

This SDK is for use with Bolt Embeddable Checkout. For the full backend API documentation, see the Embeddable Checkout API Reference.

Root Exports

Import from: @boltpay/react-native

Payment Exports

Import from: @boltpay/react-native/payments

Credit Card Controller

3D Secure

ApplePay Props

GoogleWallet Props

Types

Import from: @boltpay/react-native/payments

Styles

type Styles = { [key: `--bolt-${string}`]: string };

V3 CSS custom properties. See Styling for usage.

TokenResult

{
  token?: string;
  last4?: string;
  bin?: string;
  network?: string;
  expiration?: string;
  postal_code?: string;
}

CreditCardId

{
  id: string;       // from Bolt's Add Card API
  expiration: string;
}

CreditCardInfo

type CreditCardInfo = CreditCardId | TokenResult;

Input for fetchReferenceID().

ThreeDSConfig

{
  referenceID: string;
  jwtPayload: string;
  stepUpUrl: string;
}

ThreeDSResult

{
  success: boolean;
  error?: ThreeDSError;
}

ThreeDSError

Error subclass with a numeric code property (1001–1010). See Error Codes below.

EventType

type EventType = 'error' | 'valid' | 'blur' | 'focus';

ApplePayResult

{
  token: string;
  bin?: string;
  expiration?: string;
  billingContact?: object;
  boltReference?: string;
}

ApplePayButtonType

Apple-approved button label variants:

'plain' | 'buy' | 'checkout' | 'book' | 'subscribe' | 'donate' | 'order' | 'setUp' | 'inStore' | 'reload' | 'addMoney' | 'topUp' | 'rent' | 'support' | 'contribute' | 'tip'

ApplePayConfig

Apple Pay configuration including merchant ID (for native mode), country/currency, and total amount.

GooglePayResult

{
  token: string;
  bin?: string;
  expiration?: string;
  email?: string;
  billingAddress?: object;
  boltReference?: string;
}

GooglePayButtonType

Google-approved button label variants:

'plain' | 'buy' | 'pay' | 'checkout' | 'subscribe' | 'donate' | 'order' | 'book'

GooglePayButtonTheme

'dark' | 'light'

GooglePayConfig

{
  billingAddressCollectionFormat?: string;
  currencyCode?: string;
  label?: string;
  amount?: string;
}

Merchant and gateway config is auto-fetched from Bolt: you only provide presentation options.

Error Codes

ThreeDSError includes a numeric code property with the following values: