# telr-nodejs

> Telr Payment NodeJS

Latest version **1.0.4** (published 2018-10-24) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install telr-nodejs
pnpm add telr-nodejs
yarn add telr-nodejs
bun add telr-nodejs
```

## 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.4 |
| Published | 2018-10-24 |
| First published | 2018-10-21 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 47.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Atayyab |
| Maintainers | atayyab |
| Keywords | telr, payments, creditcard, nodejs |

## Links

- npm: https://www.npmjs.com/package/telr-nodejs
- Repository: https://github.com/Atayyab/telr-nodejs
- Homepage: https://github.com/Atayyab/telr-nodejs#readme
- Issues: https://github.com/Atayyab/telr-nodejs/issues
- npm.io page: https://npm.io/package/telr-nodejs

## Dependencies (1)

- [request](https://npm.io/package/request.md) *

## Recent versions

- 1.0.4 (latest) — 2018-10-24
- 1.0.3 — 2018-10-21
- 1.0.2 — 2018-10-21
- 1.0.1 — 2018-10-21
- 1.0.0 — 2018-10-21

## README

# Telr-nodejs

This nodejs module allows you to quickly and easily create orders and verify orders along with the detailed inquiries of customer transactions with [telr](http://telr.com/) using [nodejs](http://nodejs.org/).

You can get auth_key and store_id from telr account menu >> integrations >> paymentPage and select configuration.
isTest = 0 for live and 1 for test.
```javascript
var telr = require("telr-nodejs")("YOUR_AUTH_KEY", "YOUR_STORE_ID", {
    isTest: 0,
    currency: "sar"
});

```

#TO CREATE AN ORDER: 

```javascript
telr.order({
    orderId: 3378,
    amount: 70.5,
    returnUrl: "http://your-return-url.com",
    declineUrl: "http://url-to-call-in-decline-transaction.com",
    cancelUrl: "http://url-to-call-in-cancel-transaction.com",
    description: "Your description"
}, function(err, response){
    console.log(response);
});
```

#FETCH COMPLETE DETAILS OF ORDER & PAYMENT: 
Order reference is returned in response to create order method.
```javascript
telr.status("YOUR-ORDER-REFERENCE-HERE"
    , function(err, response){
        console.log(response);
});

```

#GET ORDER STATUS: 
Order reference is returned in response to create order method.
```javascript
telr.orderStatus("YOUR-ORDER-REFERENCE-HERE"
    , function(err, response){
        console.log(response);
});

```
#GET ORDER DETAILS: 
Order reference is returned in response to create order method.
```javascript
telr.orderDetails("YOUR-ORDER-REFERENCE-HERE"
    , function(err, response){
        console.log(response);
});

```
#GET TRANSACTION STATUS: 
Order reference is returned in response to create order method.
```javascript
telr.transactionStatus("YOUR-ORDER-REFERENCE-HERE"
    , function(err, response){
        console.log(response);
});

```
#GET TRANSACTION DETAILS: 
Order reference is returned in response to create order method.
```javascript
telr.transactionDetails("YOUR-ORDER-REFERENCE-HERE"
    , function(err, response){
        console.log(response);
});

```
#GET CUSTOMER DETAILS: 
To fetch the details of the customer of selected order
Order reference is returned in response to create order method.
```javascript
telr.transactionDetails("YOUR-ORDER-REFERENCE-HERE"
    , function(err, response){
        console.log(response);
});

```
credits: This package is a detailed implmentation/ extension of https://github.com/alirizwan/telr-payment-nodejs

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