# futurepay-form-integration-js

> [![GitHub release](https://img.shields.io/github/release/jamesmcroft/futurepay-form-integration-for-js.svg)](https://github.com/jamesmcroft/futurepay-form-integration-for-js/releases) [![npm](https://img.shields.io/npm/v/futurepay-form-integration-js.svg)

Latest version **0.5.0** (published 2024-03-26) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install futurepay-form-integration-js
pnpm add futurepay-form-integration-js
yarn add futurepay-form-integration-js
bun add futurepay-form-integration-js
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2024-03-26 |
| First published | 2023-09-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 29.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | jamesmcroft |
| Keywords | FuturePay, Worldpay, Form Integration, Recurring Payments |

## Links

- npm: https://www.npmjs.com/package/futurepay-form-integration-js
- Repository: https://github.com/jamesmcroft/futurepay-form-integration-for-js
- Issues: https://github.com/jamesmcroft/futurepay-form-integration-for-js/issues
- npm.io page: https://npm.io/package/futurepay-form-integration-js

## Dependencies (1)

- [made-data-validation](https://npm.io/package/made-data-validation.md) ^0.1.0-alpha.16

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.5.0 (latest) — 2024-03-26
- 0.3.0 — 2023-10-04
- 0.2.1 — 2023-09-27
- 0.2.0 — 2023-09-27
- 0.1.1 — 2023-09-26
- 0.1.0 — 2023-09-26

## README

# FuturePay (Worldpay) Form Integration Library for JavaScript

[![GitHub release](https://img.shields.io/github/release/jamesmcroft/futurepay-form-integration-for-js.svg)](https://github.com/jamesmcroft/futurepay-form-integration-for-js/releases)
[![npm](https://img.shields.io/npm/v/futurepay-form-integration-js.svg)](https://www.npmjs.com/package/futurepay-form-integration-js)
[![npm Downloads](https://img.shields.io/npm/dt/futurepay-form-integration-js.svg)](https://www.npmjs.com/package/futurepay-form-integration-js)
[![Build status](https://github.com/jamesmcroft/futurepay-form-integration-for-js/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/jamesmcroft/futurepay-form-integration-for-js/actions/workflows/ci.yml)
[![Twitter Followers](https://img.shields.io/twitter/follow/jamesmcroft?label=follow%20%40jamesmcroft&style=flat)](https://twitter.com/jamesmcroft)

The FuturePay (Worldpay) Form Integration Library for JavaScript is a library that allows you to integrate with FuturePay's hosted [Form Integration](http://support.worldpay.com/support/kb/bg/recurringpayments/rpfp.html) method for recurring payments with JavaScript applications.

## Install

```sh
npm install futurepay-form-integration-js
```

## Usage

### Initiating a recurring payment agreement

```js
import { FuturePayService, FuturePayType, CurrencyCode, DelayUnit, RegularAgreement, RegularAgreementOption } from 'futurepay-form-integration-js';

var service = new FuturePayService();

var agreement = {
        instId: '1234567'
        futurePayType: FuturePayType.Regular,
        intervalUnit: DelayUnit.Month,
        intervalMult: 1,
        startDelayUnit: DelayUnit.Month,
        starDelayMult: 1,
        amount: 60,
        currency: CurrencyCode.GBP,
        normalAmount: 60,
        option: RegularAgreementOption.Default,
        cartId: '1234',
        testMode: 100
    } as RegularAgreement;

/*
 * Calling this method will automatically submit the data to FuturePay and redirect the user to FuturePay's Form Integration page.
 */
await service.initiateAgreement(agreement);
```

## Contributing 🤝🏻

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](https://github.com/jamesmcroft/futurepay-form-integration-for-js/issues). You can also take a look at the [contributing guide](https://github.com/jamesmcroft/futurepay-form-integration-for-js/blob/main/CONTRIBUTING.md).

We actively encourage you to jump in and help with any issues!

## Support this project 💗

As many developers know, projects like this are built and maintained in spare time. If you find this project useful, please **Star** the repo.

## Author

👤 **James Croft**

* Website: <https://www.jamescroft.co.uk>
* Twitter: [@jamesmcroft](https://twitter.com/jamesmcroft)
* Github: [@jamesmcroft](https://github.com/jamesmcroft)
* LinkedIn: [@jmcroft](https://linkedin.com/in/jmcroft)

## License

This project is made available under the terms and conditions of the [MIT license](LICENSE).

---
_Source: https://npm.io/package/futurepay-form-integration-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._