ZarinPal Node.js SDK

https://github.com/zarinpal/zarinpal-node-sdk

Admin

A modern Node.js SDK for integrating with the ZarinPal payment gateway, offering a robust API for...

Tokens:770

Snippets:3

Trust Score:7

Update:1 year ago

Show doc for...

Tokens:

Raw

### Install ZarinPal Node.js SDK

Source: https://github.com/zarinpal/zarinpal-node-sdk/blob/main/README.md

Installs the ZarinPal Node.js SDK using npm. This is the primary method for adding the SDK to your Node.js project.

```bash
npm install zarinpal-node-sdk
```

--------------------------------

### Run Test Suite

Source: https://github.com/zarinpal/zarinpal-node-sdk/blob/main/README.md

Executes the test suite for the ZarinPal Node.js SDK to ensure its functionality and stability.

```bash
npm test
```

--------------------------------

### ZarinPal Node.js SDK API Reference

Source: https://github.com/zarinpal/zarinpal-node-sdk/blob/main/README.md

Provides a summary of the core API methods available in the ZarinPal Node.js SDK for managing payments, verifications, inquiries, refunds, and reversals.

```APIDOC
ZarinPal SDK API:

Payments:
  create(data): Creates a new payment request.
  getRedirectUrl(authority): Retrieves the payment gateway redirect URL using the authority token.

Fee Calculation:
  feeCalculation(data): Calculates the transaction fee for a given payment.

Verifications:
  verify(data): Verifies the status of a payment transaction.

Inquiries:
  inquire(data): Inquires about the details of a specific transaction.

Refunds:
  create(data): Initiates a refund for a completed transaction.

Reversals:
  reverse(data): Reverses a transaction, typically before settlement.

Unverified Payments:
  list(): Retrieves a list of payments that have not yet been verified.
```

Tokens:

Raw