Giter VIP home page Giter VIP logo

bh2_apix_ms's Introduction

API - APIX File (Gerar os arquivos APIX001 e APIX002)

About bh2

A bh2 é uma Consultoria de Negócios e Desenvolvimento de Software que atua principalmente no Mercado Financeiro. Temos auxiliado diversas empresas na construção e evolução da Transformação Digital, desde grandes instituições a startups que validaram seus produtos no Lift (Laboratório de Inovações Financeiras Tecnológicas - Coordenado pela Fenasbac e Banco Central). O Pix e Open Banking estão em alta por aqui.

Description

O objetivo deste repositório é oferecer um meio de auxiliar os desenvolvedores na geração dos arquivos APIX001 e APIX002, devem ser enviadas nestes arquivos informações do Arranjo de Pagamentos Pix definidas pela Instrução Normativa nº 32, de 26 de outubro de 2020. Fiquem à vontade para contribuir neste repositório.

Material de apoio:

=> Para envio das informações deverão ser observados os procedimentos dispostos no Anexo II à Instrução Normativa nº 32, de 2020, bem como as orientações específicas a serem divulgadas pelo Banco Central do Brasil.

A API contém duas rotas principais:

  • /api/arquivos => Geração do arquivo a partir de um payload em JSON que devolve o XML.
  • /api/arquivos/upload-csv => Geração do arquivo a partir de um CSV customizado, este CSV permite uma extração simples das informações de bases de dados para gerar o XML. Arquivo de demonstração em src/files.

API - Stack:

State

Develop [pending]
Homolog [pending]
Production [pending]

Installation

$ npm install

Configuration

API configuration on .env file.

DEVS: Create .env file on root folder.

# server params
NODE_ENV=dev
LOG_LEVEL=HIGH
PORT=300
HOST=localhost
SSL=false

Running the app

# build tsc
$ npm run build

# development 
$ npm run dev

# development (only windows)
$ npm run devw

# production
$ npm run start

Routes

Starting Xhelpers Hapi server API
Settings API: Mongoose disabled;
Settings API: Sequelize disabled;
Settings API: SSL disabled;
Settings API: AppKey disabled;
Settings API: JWT enabled;
Settings API: SSO disabled;
====================================================================================================
🆙  Server api    : http://localhost:300/
🆙  Server doc    : http://localhost:300/documentation
🆙  Server status : http://localhost:300/status
====================================================================================================
Routing table:
        🔎  get -       /documentation
        🔎  get -       /health
        🔎  get -       /status
        🔎  get -       /swagger.json
        🔎  get -       /api/arquivos/demo
        🔎  get -       /api/arquivos/schema
        📄  post -      /api/arquivos/upload-csv
        📄  post -      /api/arquivos/

Cloud (AWS/Azure/GCP/Heroku)

DEMO: https://apix-ms.bh2.tech/documentation

Docker build

$ api-apix

Test

[Pending]

Support

[Pending]

Stay in touch

License

MIT License

bh2_apix_ms's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

2859pia2019

bh2_apix_ms's Issues

Atualização de Padrão Documento APIX

Dia 4 foi feita algumas atualizações no padrão dos documentos auxiliares do pix.

O projeto já contempla essa atualização ou seria necessário um patch para se adequar a atualização?

image

Parâmetros number

Alguns parâmetros como: Perc50TempoExpUsuarioIntra, ValorReceita, QtdTransacoes, etc são tipados como "number" e quando eu envio um int 0 recebo "must be a positive number" e se eu não tiver feito nenhuma transação em um mês ou não tiver feito uma devolução em um mês o que eu faço?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.