@revolut/checkout/README.md

RevolutCheckout.js as npm module

# [RevolutCheckout.js](https://developer.revolut.com/docs/revolut-checkout-js/)

[![](https://flat.badgen.net/npm/v/@revolut/checkout)](https://www.npmjs.com/package/@revolut/checkout) [![](https://flat.badgen.net/bundlephobia/minzip/@revolut/checkout)](https://bundlephobia.com/result?p=@revolut/checkout)

## Install

<pre>
<a href="https://www.npmjs.com">npm</a> install @revolut/checkout
</pre>

<pre>
<a href="https://yarnpkg.com">yarn</a> add @revolut/checkout
</pre>

## Usage

### `RevolutCheckout`

#### Params

- `token: string` — `public_id` from [create payment order](https://developer.revolut.com/api-reference/merchant/#operation/createOrder) API request
- <code>mode?: '<a href="https://business.revolut.com">prod</a>' | '<a href="https://sandbox-business.revolut.com">sandbox</a>'</code> — [API](https://developer.revolut.com/api-reference/merchant/) environment, defaults to `'prod'`

```js
import RevolutCheckout from '@revolut/checkout'

RevolutCheckout('TOKEN_XXX', 'prod').then((instance) => {
  // Work with instance:

  // instance.payWithPopup()
  // instance.createCardField()
  // ...
})
```

For more information read our [official documentation](https://developer.revolut.com/docs/revolut-checkout-js/).


### TypeScript support

Following types are availble for import:

```ts
import {
  ValidationErrorType,
  ValidationError,
  RevolutCheckoutErrorType,
  RevolutCheckoutError,
  FieldStatus,
  FieldClasses,
  FieldStyles,
  RevolutCheckoutCardField,
  RevolutCheckoutInstance,
} from '@revolut/checkout'
```

## Docs

- [RevolutCheckout.js reference](https://developer.revolut.com/docs/revolut-checkout-js/)
- [API guide](https://developer.revolut.com/docs/accept-payments/)
- [API reference](https://developer.revolut.com/api-reference/merchant/)
- [Integration examples](https://developer.revolut.com/docs/accept-payments/#tutorials)
- [Plugins](https://developer.revolut.com/docs/accept-payments/#plugins)

---
© 2023 Revolut Ltd