heidelpaynodejs's Introduction

Heidelpay SDK NodeJS

The Heidelpay SDK NodeJS provides convenient access to the Heidelpay API from applications written in server-side JavaScript.

Documentation

See the Node API docs.

Installation

Install the package with:

npm install --save @heidelpay/nodejs-sdk

Usages

The package needs to be configured with your private key. Make sure you have it first

Using Common JS

var Heidelpay = require('@heidelpay/nodejs-sdk').default;

// Create new instance Heidelpay
var heidelpay = new Heidelpay('s-priv-...');

Or using ES module

import Heidelpay from '@heidelpay/nodejs-sdk';

// Create new instance Heidelpay
const heidelpay = new Heidelpay('s-priv-...');

Or using TypeScript:

import Heidelpay from '@heidelpay/nodejs-sdk';

// Create new instance Heidelpay
const heidelpay = new Heidelpay('s-priv-...');

Example

Using Promise

Authorize with a payment type (Card)

var Heidelpay = require('@heidelpay/nodejs-sdk').default;
var Card = require('@heidelpay/nodejs-sdk').Card;
var Customer = require('@heidelpay/nodejs-sdk').Customer;

// Create new instance Heidelpay
var heidelpay = new Heidelpay('s-priv-...');

// New a card with pan number and exipry date
var card = new Card('471110xxxxxx0000', '01/xxxx');

// Set CVC
card.setCVC('xxx');

// Create customer object
var customer = new Customer('Rene', 'Fred');

heidelpay.createCustomer(customer).then(function(newCustomer) {
  // Create payment type then authorize (Card)
  return heidelpay.createPaymentType(card);
}).then(function(paymentCard) {    
  // Authorize with payment card
  return paymentCard.authorize({
    amount: 100,
    currency: 'EUR',
    typeId: paymentCard.getId(),
    returnUrl: 'https://www.google.at'
  })
}).then(function(authorize) {
  // Authorize successful
  console.log('authorize', authorize.getId());
}).catch(function (error) {
  // Handle error
  console.log('error', error);
});

Using async / await (ES6 style)

import Heidelpay, {Card} from '@heidelpay/nodejs-sdk';

// Create new instance Heidelpay
const heidelpay = new Heidelpay('s-priv-...');

// New a card with pan number and exipry date
const card = new Card('471110xxxxxx0000', '01/xxxx');

// Set CVC
card.setCVC('xxx');

// Create customer object
const customer = new Customer('Rene', 'Fred');

// Should wrap these code into async function (async/await syntax)
try {
  // Create a new customer
  const newCustomer = await heidelpay.createCustomer(customer);

  // Create payment type then authorize (Card)
  const paymentCard = await heidelpay.createPaymentType(card);

  // Authorize with payment card
  const authorize = await paymentCard.authorize({
    amount: 100,
    currency: 'EUR',
    typeId: paymentCard.getId(),
    returnUrl: 'https://www.google.at'
  });
} catch (error) {
  // Handle error
  console.log('error', error);
}

License

Apache 2.0

heidelpaynodejs's People

Contributors

Stargazers

Watchers

heidelpaynodejs's Issues

Absence of releases

There have currently been 42 commits to devel, including bugfixes and functionality additions, since the last official release of this package 14 months ago.

When can the next release be expected that officially makes these changes available?

Type definition of constructor not sufficient

We stumbled upon an error with an API change of you (I guess).

For the creation of a payment type we used the same Heidelpay SDK instance as for authorizing the payment, for example.
This, however, does not work anymore. We recognized that the instance for creating a payment type needs the public key, while authorizing utilizes the private key. The documentation of this is not sufficient and it is only recognizable in your code examples (https://docs.unzer.com/reference#testinput & https://docs.unzer.com/reference#paymentsauthorize).

The type definition of the SDK-Constructor is also not sufficient, as it only describes the private key as input parameter.

export default class Heidelpay {
    constructor(privateKey: string, locale?: string, env?: string);
 [...]

Npm package out of date

I see that this github repo has the latest changes needed to implement 3dsecure and further commits that are not in sync with the project:

https://www.npmjs.com/package/@heidelpay/nodejs-sdk

The last release of this npm is about 29 days ago, and this repo has changes that we need to implement some payments.

Is there any plan to make a release in npm?

Warm regards and thanks

Recommend Projects

heidelpay / heidelpaynodejs Goto Github PK