# react-nab-velocity-checkout

> React wrapper for Nab Velocity hosted form.

Latest version **1.0.3** (published 2019-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-nab-velocity-checkout
pnpm add react-nab-velocity-checkout
yarn add react-nab-velocity-checkout
bun add react-nab-velocity-checkout
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-03-20 |
| First published | 2019-03-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 132.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Cristian Torres |
| Maintainers | ctorresthrash |
| Keywords | react, nab-velocity, nab, velocity, checkout |

## Links

- npm: https://www.npmjs.com/package/react-nab-velocity-checkout
- Repository: https://github.com/onwarddev/react-nab-velocity-checkout
- Homepage: https://github.com/onwarddev/react-nab-velocity-checkout#readme
- Issues: https://github.com/onwarddev/react-nab-velocity-checkout/issues
- npm.io page: https://npm.io/package/react-nab-velocity-checkout

## Dependencies (3)

- [react](https://npm.io/package/react.md) ^16.4.0
- [webpack](https://npm.io/package/webpack.md) ^4.12.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2

## 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

- 1.0.3 (latest) — 2019-03-20
- 1.0.2 — 2019-03-18
- 1.0.1 — 2019-03-18
- 1.0.0 — 2019-03-18

## README

# **Welcome**!

## This is a react component that acts as a wrapper for the [Nab Velocity](https://nabvelocity.com/) [Hosted Payment Form](<[https://duckduckgo.com](https://nabvelocity.com/developers/hosted-payment-forms/)>).

## There is no need to add script tags in your _index.html_.

# _Props:_

| Name              | Type                         | Required | Description                                                  |
| ----------------- | ---------------------------- | -------- | ------------------------------------------------------------ |
| onProcessPayment  | function                     | YES      | Payment success callback                                     |
| component         | string / Component(function) | NO       | Button component that triggers the form (default `<button>`) |
| amount            | number                       | YES      | Transaction ammount of money                                 |
| text              | string / element             | NO       | Button text                                                  |
| terminalProfileId | string                       | YES      | Your Nab Velocity's POS system id                            |
| invoiceNum        | string                       | NO       | Inner POS System invoice number                              |
| description       | string                       | NO       | Payment descriptor                                           |
| email             | string                       | NO       | Customer email                                               |
| billingName       | string                       | NO       | Customer name                                                |
| billingAddress    | string                       | NO       | Customer address                                             |
| billingCity       | string                       | NO       | Customer city                                                |
| billingState      | string                       | NO       | Customer state  (abbreviation)                               |
| billingPostalCode | string                       | NO       | Customer postal code                                         |

# _Example:_

```jsx
import React, { Component } from "react";
import NabVelocity from "react-nab-velocity-checkout";
import Button from "./Button";

class App extends Component {
  render() {
    return (
      <div>
        <NabVelocity   
          component={Button}       
          amount={12}
          terminalProfileId="234"
          invoiceNum='320329304'
          description="Awesome product"
          email="johndoe@mail.com"
          billingName="John Doe"
          billingAddress="742 Evergreen Terrace"
          billingCity="Miami"
          billingState="FL" //Abbreviation is important!
          text="Pay Your Awesome Product"
          billingPostalCode="12345"
        />
      </div>
    );
  }
}

export default App;

```

---
_Source: https://npm.io/package/react-nab-velocity-checkout · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
