Payrexx-sdk NPM

Payrexx SDK

Payrexx SDK for NodeJS with TypeScript support.

Supported Payrexx API functionalities:

Paylink
Gateway
QR code
Payment Provider
Payment Method
Payout
Transaction
Design

Unsupported Payrexx API functionalities:

Subscription API is still in experimental state on the Payrexx, hence it will not be supported by this library

Visit the Payrexx for more information.

Disclaimer 🚧

This library is unofficial and is developed independently from the Payrexx payment provider.

Please note that QR code is not fully tested.

How to use 🖥️

Install library by running command

npm i payrexx-sdk

Start by creating the Payrexx client. You will need to provide your Payrexx instance and API secret.

const client = new PayrexxClient('PAYREXX_INSTANCE', 'API_SECRET')

API

API is grouped by Payrexx functionalities:

client.api.paylink
client.api.gateway
client.api.qrCode
client.api.paymentProvider
client.api.paymentMethod
client.api.payout
client.api.transaction
client.api.design

Use examples

Retrieve a paylink

await client.api.paylink.retrieve(id);

Create a paylink

const request = new PaylinkRequest('title', 'description', 'referenceId', 'purpose', amount, 'currency');
request.addField('forename', true, 'Name');
request.addField('surname', false, 'Last Name');

const result = await client.api.paylink.create(request);