Configuration - Reeple SDK

All options are passed to the Reeple constructor as a single ReepleConfig object.

Required fields

Field	Type	Description
`publicKey`	`string`	Your Reeple public key
`amount`	`number`	Payment amount in the currency’s standard unit (e.g. `50` for ₦50 or $50)
`currency`	`Currency`	Currency code. See supported currencies
`narration`	`string`	Short description of the payment shown on the checkout page
`customer.email`	`string`	Customer’s email address
`customer.firstName`	`string`	Customer’s first name
`customer.lastName`	`string`	Customer’s last name
`customer.phoneNumber`	`string`	Customer’s phone number (include country code, e.g. `+2348012345678`)
`meta`	`object`	Arbitrary key-value data attached to the transaction. Pass `{}` if you have nothing to add

amount is a plain decimal number in the currency’s standard unit — not kobo, cents, or any other smallest-unit representation. amount: 50 charges ₦50.00 for NGN, and amount: 49.99 charges $49.99 for USD. See Supported Currencies for more examples.

Optional fields

Field	Type	Default	Description
`callbackUrl`	`string`	—	URL Reeple redirects to after payment. Required if you want `onSuccess` to fire in the browser
`reference`	`string`	auto-generated	Your unique transaction reference. SDK generates one if omitted
`mode`	`'sandbox' \| 'production'`	`'production'`	Use `'sandbox'` for testing — see Sandbox / Testing

Callbacks

Callback	Signature	Fires when
`onSuccess`	`(data: ReepleSuccessData) => void`	Payment completes and the iframe reaches the callback URL
`onClose`	`() => void`	User closes the modal without completing payment
`onError`	`(error: Error) => void`	API call fails, network error, or session times out (10 min)
`onLoad`	`() => void`	The payment iframe finishes loading

For the full ReepleSuccessData shape and how to verify a payment server-side, see Callbacks & Verification.

Methods

reeple.open();   // Initiates the API call and opens the payment modal
reeple.close();  // Programmatically closes the modal (fires onClose)

Calling open() while the modal is already open is a no-op.