pix-payload

KO | EN

gitlite — search

#javascript #react #ai #typescript #llm #go #golang #linux #docker #nodejs #kubernetes #vue #security #mcp

(★ 81)

Published package on NPM. Use it when you need to generate a pix payload following the pix standardization rules. This payload can be transformed into a QR Code or, for example, used for PIX "copy & paste".

pix-payload Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Package Pix Payload

Use it when you need to generate a pix payload following the pix standardization rules. This payload can be transformed into a QR Code or, for example, used for PIX "copy & paste".

## 🔧 Installation

Install the public package:
```bash
npm i pix-payload
```
## 👨‍💻 How To Use

```javascript
import { payload } from "pix-payload"

const data = {
    key: "devcarlosalberto@gmail.com",
    name: "Carlos Alberto",
    city: "Praia Grande",
    amount: 150,
    transactionId: "PAY123",
}

const myPayload = payload(data)
```

The parameters when calling the payload() function are these and must be inside an object:

`key: string` 
`name: string` 
`city: string` 
`amount?: number` 
`transactionId?: string`

The values accepted as pix key are listed below and must follow the formatting pattern followed by their respective example:

*CPF*: `12345678900` 
*CNPJ*: `00038166000105` 
*E-mail*: `fulano_da_silva.recebedor@example.com` 
*Phone*: `+5561912345678`

## 🕹️ Functions

- Create payload PIX

## 🚀 Technologies

Thats project has utilized following technologies:
- Typescript

## 🔗 Links
[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://devcarlosalberto.netlify.app)
[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/devcarlosalberto)

## Authors

- [@devcarlosalberto](https://www.github.com/devcarlosalberto)

pix-payload

pix-payload Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pix-payload

pix-payload Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README