react-xpay-build v1.2.3

React XPay Build

React library for Nexi's XPay Build

Requirements

The minimum supported version of React is v16.8. If you use an older version you need to upgrade React to use this library.

Documentation

• XPay Build

Library usage example

• Import XPay's sdk script with loadSdk helper. Use isProduction = false to load the test environment.
• Use XPayProvider component passing the formatted order obtained from your backend integration Documentation
• Pass a nonceHandler function to the provider to handle card payments. It's called at the custom event XPay_Nonce.

import React from "react";
import { loadXPay, XPayProvider } from "react-xpay-build";

const sdkLoader = loadXPay({
	alias: "YOUR_ALIAS",
	isProduction: false,
});

const App = () => {
	const nonceHandler = (_nonceResp) => {
		// submit nonce response data to your backend
		// to pay with the server-to-server integration
	};
	return (
		<XPayProvider
			sdk={sdkLoader}
			apiKey="YOUR_ALIAS"
			order={order}
			nonceHandler={nonceHandler}
		>
			<YourCheckoutComponent />
		</XPayProvider>
	);
};

Pay with card

• In your checkout component you can use the XPayCard component to show XPay's card input.

• To pay you can use the use yourCardRef.current.createNonce() or the helper pay function from useCard
  You need to pass a ref to the XPayCard component

import { XPayCard, useCard } from "react-xpay-build";

const YourCheckoutComponent = () => {
	const cardRef = useRef(null);
	const handlePayWithComponent = () => {
		cardRef.current.createNonce();
	};
	const { pay } = useCard();
	const handlePayWithHelperFx = useCallback(() => {
		pay(cardRef);
	}, [cardRef]);

	return (
		<>
			<XPayCard ref={cardRef} />
			<button onClick={handlePayWithHelperFx}>Pay</button>
			<button onClick={handlePayWithComponent}>Or use this Pay button</button>
		</>
	);
};

Customizing card component

### XPay Card

You can pass a style prop to XPayCard component to customize input forms.

XPay Build does not support all css properties (e.g. backgroundColor or border), you'll find available ones on style prop type.

Here is an example of available properties.

const style = {
	common: {
		fontFamily: "Arial",
		fontSize: "15px",
		fontStyle: "Normal",
		fontVariant: "Normal",
		letterSpacing: "1px",
		"::placeholder": {
			color: "#d41111",
		},
		color: "#5c5c5c",
	},
	correct: {
		fontFamily: "Arial",
		fontSize: "15px",
		fontStyle: "Normal",
		fontVariant: "Normal",
		letterSpacing: "1px",
		"::placeholder": {
			color: "#d41111",
		},
		color: "#5c5c5c",
	},
	error: {
		fontFamily: "Arial",
		fontSize: "15px",
		fontStyle: "Normal",
		fontVariant: "Normal",
		letterSpacing: "1px",
		"::placeholder": {
			color: "#d41111",
		},
		color: "#5c5c5c",
	},
};

<XPayCard ref={cardRef} style={style} />;

Customizing card's wrapper div

You can pass a react style object prop styleWrapper to XPayCard to customize the card's wrapper div.

const Component = () => {
	return <XPayCard ref={cardRef} styleWrapper={{ background: "#ccc" }} />;
};

Card errors

By default card errors are enabled.

You can style errors with styleErrors property

const Component = () => {
	return <XPayCard ref={cardRef} styleErrors={{ color: "red" }} />;
};

You can hide default errors and pass an handler that will be called on XPay_Card_Error event, to handle your own errors (e.g. to trigger an alert/toast with the error message)

const Component = () => {
	const cardErrorHandler = (msg: string) => alert(msg);
	return (
		<XPayCard
			ref={cardRef}
			showErrors={false}
			cardErrorHandler={cardErrorHandler}
		/>
	);
};

Pay with Alternate Payment Methods (APM)

• In your XPayProvider you need to pass a paymentResultHandler documentation callback function, it will be called at XPay_Payment_Result XPay's custom event.
• In your checkout component (inside XPayProvider) you can use <XPayAPM /> component to pay with alternate payment methods
• You can choose which APM buttons to show passing a single payment method or a payment methods array to the APM component

const App = () => {
	return (
		<XPayProvider
			sdk={sdkLoader}
			apiKey="YOUR_ALIAS"
			order={order}
			paymentResultHandler={paymentResultHandler}
		>
			<YourCheckoutComponent />
		</XPayProvider>
	);
};

• Pay with all available payment methods

import { XPayAPM } from "react-xpay-build";

const YourCheckoutComponent = () => {
	return <XPayAPM />;
};

• Show only APM buttons in the selected array

import { XPayAPM } from "react-xpay-build";

const YourCheckoutComponent = () => {
	return <XPayAPM paymentMethodName={["SATISPAY", "PAYPAL"]} />;
};

• Pick your selected APM buttons (e.g. to show them in different page sections)

import { XPayAPM } from "react-xpay-build";

const YourCheckoutComponent = () => {
	return (
		<>
			<div style={{ paddingBottom: "20px" }}>
				<XPayAPM paymentMethodName="PAYPAL" />
			</div>
			<XPayAPM paymentMethodName="AMAZONPAY" />
			<XPayAPM paymentMethodName="SATISPAY" />
		</>
	);
};

Recurring Payments & Custom configs

You can pass a customConfig object to XPayProvider to handle recurring payments and other custom parameters. All parameters in the customConfig will be added to the library config object. Properties into the main object will be appended to tha main config object.

const customConfig = {
	main: {
		requestType: "AN",
		serviceType: "AN",
	},
	baseConfig: {},
	paymentParams: {},
	customParams: {
		num_contratto: "123",
	},
	language: "ITA",
};

const App = () => {
	return (
		<XPayProvider
			sdk={sdkLoader}
			apiKey="YOUR_ALIAS"
			order={order}
			paymentResultHandler={paymentResultHandler}
			customConfig={customConfig}
		>
			<YourCheckoutComponent />
		</XPayProvider>
	);
};