# @paylike/client

> High-level client for the API documented at: https://github.com/paylike/api-reference. It is using [paylike/request](https://www.npmjs.com/package/@paylike/request) under the hood.

Latest version **1.0.0** (published 2022-11-03) · 0 weekly downloads

## Install

```sh
npm install @paylike/client
pnpm add @paylike/client
yarn add @paylike/client
bun add @paylike/client
```

## 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.0 |
| Published | 2022-11-03 |
| First published | 2021-04-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 15.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | paylike_tech, thomas-jensen, larsbothomsen, adomas.d, gergo, misozask, rover22 |

## Links

- npm: https://www.npmjs.com/package/@paylike/client
- Repository: https://github.com/paylike/js-client
- Homepage: https://github.com/paylike/js-client#readme
- Issues: https://github.com/paylike/js-client/issues
- npm.io page: https://npm.io/package/@paylike/client

## Dependencies (2)

- [serialize-error](https://npm.io/package/serialize-error.md) ^8.1.0
- [@paylike/request](https://npm.io/package/@paylike/request.md) ^3.0.2

## Recent versions

- 1.0.0 (latest) — 2022-11-03
- 0.2.3-beta.0 (beta) — 2022-01-11
- 0.2.3 — 2022-10-27
- 0.2.2 — 2021-08-22
- 0.2.1 — 2021-05-22
- 0.2.0 — 2021-05-13
- 0.1.0 — 2021-04-30

## README

# Paylike API client

High-level client for the API documented at:
https://github.com/paylike/api-reference. It is using
[paylike/request](https://www.npmjs.com/package/@paylike/request) under the
hood.

## Quick start

### Browser (or e.g. Deno)

```js
// swap esm.sh for any "npm CJS to ESM CDN"
import Paylike from 'https://esm.sh/@paylike/client@1.0.0'

const paylike = Paylike()
paylike.tokenize('pcn', '1000000000000000').then(console.log, console.error)
```

### Node.js

```sh
npm install @paylike/client
```

```js
import Paylike from '@paylike/client'

const paylike = Paylike()
paylike.tokenize('pcn', '1000000000000000').then(console.log, console.error)
```

## Methods

```js
.tokenize(type, value[, opts])
// → Promise<Token>
```

```js
.payments.create(payment, hints, challengePath[, opts])
// → Promise<Token>
```

### Apple Pay

```js
.applepay.tokenize(event.payment.token.paymentData[, opts])
// → Promise<Token>
.applepay.approvePaymentSession(configurationId, text[, opts])
// → Promise(merchantSession)
```

#### Example

```js
const session = new ApplePaySession(3, {
  // ...
})
session.onvalidatemerchant(() => {
  paylike.applepay
    .approvePaymentSession(configurationId, 'Pretty Shop')
    .then((ms) => session.completeMerchantValidation(ms))
})
session.onpaymentauthorized((e) => {
  paylike.applepay.tokenize(e.payment.token.paymentData).then((token) => {
    // follow same payment flow as usual
    pay({
      // ...
      applepay: token,
    }).then(
      (r) => {
        session.completePayment(ApplePaySession.STATUS_SUCCESS)
        // ...
      },
      (err) => {
        session.completePayment(ApplePaySession.STATUS_FAILURE)
        // ...
      }
    )
  })
})
session.begin()
```

## Error handling

The methods may throw any error forwarded from the used fetch implementation as
well as one of the below error classes. All error classes are exposed on the
main function.

```js
const paylike = Paylike()
paylike.RateLimitError
```

- `RateLimitError`

  May have a `retryAfter` (milliseconds) property if sent by the server
  specifying the minimum delay.

- `TimeoutError`

  Has a `timeout` (milliseconds) property specifying the time waited.

- `ServerError`

  Has `status` and `headers` properties copied from the fetch response.

- `ResponseError`

  These errors correspond to
  [status codes](https://github.com/paylike/api-reference/blob/master/status-codes.md)
  from the API reference. They have at least a `code` and `message` property,
  but may also have other useful properties relevant to the specific error code,
  such as a minimum and maximum for amounts.

## Logging

Pass a log function of the format `(i) => {}` to catch internal (structured)
logging.

```js
const paylike = Paylike({log: console.log})
```

## Timeouts and retries

There is a default timeout for all HTTPS requests of 10 seconds and a retry
strategy of 10 retries with increasing delay (check the source for details). The
default maximum timeout (retries and timeouts accumulated) is 72,100
milliseconds.

Both of these parameters can be customized:

```js
const paylike = Paylike({
  timeout: 10000,
  retryAfter: (err, attempts) => {
    // err = current error
    // attempts = total attempts so far
    return false // no more attempts (err will be returned to the client)
    // or
    return 1000 // retry after this many milliseconds
  },
})
```

Both options can be set on the factory or the individual method.

---
_Source: https://npm.io/package/@paylike/client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._