https://github.com/singleware/payzen

Rest client for the PayZen API.
https://github.com/singleware/payzen

browser javascript payment-gateway payzen singleware typescript

Last synced: 4 days ago
JSON representation

Rest client for the PayZen API.

• Host: GitHub
• URL: https://github.com/singleware/payzen
• Owner: Singleware
• License: mit
• Created: 2019-07-30T01:14:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-07-17T17:59:35.000Z (over 4 years ago)
• Last Synced: 2024-11-07T16:19:01.945Z (8 days ago)
• Topics: browser, javascript, payment-gateway, payzen, singleware, typescript
• Language: TypeScript
• Homepage:
• Size: 206 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PayZen

Rest client for the PayZen gateway, for more info, please check the [Official Documentation](https://payzen.io/pt-BR/rest/V4.0/api/reference.html)

## Usage

Authorizing the connection.

```ts

import * as PayZen from '@singleware/payzen';

import * as Injection from '@singleware/injection';

// Basic authorization.

Injection.resolve(PayZen.Client).setAuthorization('USER', 'SECRET');

```

Creating new credit card token.

```ts

import * as PayZen from '@singleware/payzen';

import * as Injection from '@singleware/injection';

// Getting a promise to receive the credit card token.

const promise = Injection.resolve(PayZen.Tokens.Mapper).create({

  currency: PayZen.Types.Currency.BRL,

  customer: {

    email: '[email protected]'

  },

  paymentForms: [

    {

      paymentMethodType: PayZen.Types.Payment.Method.Card,

      pan: 'CARD_NUMBER',

      expiryMonth: 'CARD_MONTH',

      expiryYear: 'CARD_YEAR',

      securityCode: 'CARD_CVV'

    }

  ]

});

```

Creating a new payment based on the received card token.

```ts

import * as PayZen from '@singleware/payzen';

import * as Injection from '@singleware/injection';

// Getting a promise to receive the payment uuid.

const promise = Injection.resolve(PayZen.Payments.Mapper).create({

  amount: 1000,

  currency: PayZen.Types.Currency.BRL,

  paymentMethodToken: 'CARD_TOKEN',

  customer: {

    email: '[email protected]'

  }

});

```

Creating a new subscription based on the received card token.

```ts

import * as PayZen from '@singleware/payzen';

import * as Injection from '@singleware/injection';

// Getting a promise to receive the subscription id.

const promise = Injection.resolve(PayZen.Payments.Mapper).create({

  amount: 1000,

  currency: PayZen.Types.Currency.BRL,

  effectDate: new Date(),

  paymentMethodToken: 'CARD_TOKEN',

  rrule: 'RRULE:FREQ=MONTHLY;BYMONTHDAY=1;COUNT=1',

  customer: {

    email: '[email protected]'

  }

});

```

## Install

Using npm:

```sh

npm i @singleware/payzen

```

## License

[MIT © Silas B. Domingos](https://balmante.eti.br)