Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucadiba/satispay-client
A Node.js client for Satispay APIs with built-in TypeScript types.
https://github.com/lucadiba/satispay-client
satispay
Last synced: about 2 months ago
JSON representation
A Node.js client for Satispay APIs with built-in TypeScript types.
- Host: GitHub
- URL: https://github.com/lucadiba/satispay-client
- Owner: LucaDiba
- License: mit
- Created: 2023-09-06T22:57:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-17T04:14:46.000Z (3 months ago)
- Last Synced: 2024-09-17T07:19:53.885Z (3 months ago)
- Topics: satispay
- Language: TypeScript
- Homepage:
- Size: 1020 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Satispay Node.js client
> A JavaScript Node.js client for Satispay APIs with built-in TypeScript types.
> This package supports both ESM and CommonJS.
Installation •
Usage •
Authentication •
Contributing •
License
---
## Installation
Install the package using your preferred package manager:
```bash
npm install @lucadiba/satispay-client
```
## Usage
Import the package in your Node.js application:
```typescript
import Satispay from "@lucadiba/satispay-client";
```
### Initialize the client
Initialize the client with your `keyId` and `privateKey`. You can get both using this package. See the [Authentication](#authentication) section for more details.
```typescript
const satispay = new Satispay.Client({
keyId: "ldg9sbq283og7ua1abpj989kbbm2g60us6f18c1sciq...",
privateKey: "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBg...",
environment: "sandbox", // optional, defaults to "production"
});
```
### Create a payment
```typescript
const payment = await satispay.payments.create({
flow: "MATCH_CODE",
amountUnit: 100,
currency: "EUR",
});
// Save the payment id
const paymentId = payment.id;
// Redirect the user to the redirectUrl
const redirectUrl = payment.redirect_url;
```
### Get a payment
```typescript
satispay.payments.get({
id: "payment_id",
});
```
### Get all payments
```typescript
satispay.payments.getAll();
```
### Update a payment
```typescript
satispay.payments.update({
id: "payment_id",
action: "CANCEL",
});
```
## Authentication
The Satispay API uses an authentication method based on a RSA key pair. You can generate a new key pair using the `generateKeyPair` method:
```typescript
import Satispay from "@lucadiba/satispay-client";
const { publicKey, privateKey } =
await Satispay.Authentication.generateKeyPair();
```
Then, you can use the `authenticateWithToken` method to get the `keyId` needed to initialize the client.
The token is a 6 characters string that you can find in the Satispay Business Dashboard. It can only be used once, so you need to save the `keyId`, which can be reused and does not expire.
```typescript
const { keyId } = await Satispay.Authentication.authenticateWithToken({
token: "623ECX",
publicKey,
});
```
Finally, you can initialize the client:
```typescript
const satispay = new Satispay.Client({
keyId,
privateKey,
});
```
## Errors
### Handling errors
This package throws an error when the Satispay API returns an error. You can catch the error and handle it as you prefer.
If the errors comes from the Satispay API, the error will be an instance of `SatispayError`. There is a utility method to check if an error is a `SatispayError`.
```typescript
import { SatispayError } from "@lucadiba/satispay-client";
try {
await satispay.payments.create({
flow: "MATCH_CODE",
amountUnit: -100,
currency: "EUR",
});
} catch (error) {
if (SatispayError.isSatispayError(error)) {
// The SatispayError type is automatically inferred
console.error({
message: error.message,
data: error.data,
code: error.code,
status: error.status,
});
} else {
// The type of error is unknown
console.error(error);
}
}
```
## Contributing
Contributions, issues and feature requests are welcome!
## License
Copyright © 2022 [Luca Dibattista](https://github.com/LucaDiba).
This project is [MIT](https://github.com/LucaDiba/satispay-client/blob/main/LICENSE) licensed.