vendure-pagarme-plugin

KO | EN

gitlite — search

#hacktoberfest #react #llm #go #machine-learning #linux #docker #java #awesome-list #vue #pytorch #security #ios #mcp

vendure-pagarme-plugin

(★ 11)

💳 A plugin to enable Pagar.me as a payment provider for Vendure

vendure-pagarme-plugin Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Vendure Pagar.me Plugin

[![npm (scoped)](https://img.shields.io/npm/v/vendure-pagarme-plugin.svg)](https://www.npmjs.com/package/vendure-pagarme-plugin)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Crowdin](https://badges.crowdin.net/vendure-pagarme-plugin/localized.svg)](https://crowdin.com/project/vendure-pagarme-plugin)

💳 A plugin to enable Pagar.me as a payment provider for Vendure. Its a WORK IN PROGRESS. In issues you can find what need to be done.

## 🌟 Feature
This plugin have inside it a lot of stuff:
- A **[`PaymentMethodHandler`](https://www.vendure.io/docs/typescript-api/payment/payment-method-handler/) to createPayments** and configure Pagar.me transaction
- A **`PagarmePostbackController` controller** to receive postback request from Pagar.me
- A **[custom field](https://www.vendure.io/docs/developer-guide/customizing-models/#customizing-models-with-custom-fields) `pagarmePaymentMethod`** on Order to change the Pagar.me Payment Method BEFORE create a payment. You can define to calculate discount on Order based on that.
- A `pagarmeBoletoPromotionAction` and `pagarmeCreditCardPromotionAction` to create promotion based on what payment method selected by the user
- Refund credit card payments in Admin UI

## 🚩 Roadmap
- Add unit and E2E test
- Cronjob for cancel order after some time
- CRUD for save bank information for refund
- CRUD for save credit card's ID to create transactions based on that

## ⚙️ Install
### 1. Install and configure Vendure
[Here](https://www.vendure.io/docs/getting-started/) you can find out how to install

### 2. Install the package
```bash
npm install vendure-pagarme-plugin --save
```

### 3. Add the plugin in Vendure configuration
```typescript
import { PagarmePlugin } from 'vendure-pagarme-plugin';
const config: VendureConfig = {
  ...
  plugins: [
    PagarmePlugin
  ]
}
```

### 4. Add this package in your storefront (Optional)
To create a payment with this plugin you will need to fill with metadata in `createPayment` mutation. If you use Typescript in your storefront you can use the `PagarmePaymentMethodMetadata` type to know witch fields that will be need. 😁

```typescript
import { PagarmePaymentMethodMetadata } from 'vendure-pagarme-plugin';
```

### 5. Configure Pagar.me
You will need to enable and configure the options to make work. You can edit this in _Payment Method_ section in Vendure Admin UI

### 6. Enjoy!
It's done!

## 😍 Do you like?
*Please, consider supporting my work as a lot of effort takes place to create this repo! Thanks a lot.*

## 🌐 Localization
This project localization its hosted in [Crowdin](https://crowdin.com/project/vendure-pagarme-plugin).

## ❗️ License
MIT

vendure-pagarme-plugin

vendure-pagarme-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

vendure-pagarme-plugin

vendure-pagarme-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README