PHPackages                             fausto/src - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. fausto/src

ActiveProject[API Development](/categories/api)

fausto/src
==========

Fpay API module

02PHP

Since May 27Pushed 4y ago1 watchersCompare

[ Source](https://github.com/Fgamamarins/fpay)[ Packagist](https://packagist.org/packages/fausto/src)[ RSS](/packages/fausto-src/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

[![](https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg)](https://laravel.com)

Como instalar o pacote no seu projeto Laravel/Lumen
---------------------------------------------------

[](#como-instalar-o-pacote-no-seu-projeto-laravellumen)

Dentro do seu projeto, no terminal execute o seguinte comando:

`composer require fausto/fpay-module "dev-master"`

Após o pacote ser instalado, deve adicionar o provider no arquivo `config/app.php`, para isso basta abrir o arquivo e adicionar no array de providers a seguinte linha ` \Fgmarins\Fpay\FpayServiceProvider::class`

Obs: O provider deve ser adicionado para mergear o arquivo de rotas e elas ficarem disponiveis para requisição.

Após ter feito isso deve adicionar o ***CLIENT\_CODE*** e ***CLIENT\_KEY*** no seu arquivo ***.env***

Para a execução do teste pode ser adicionado as seguintes linhas no arquivo ***.env***

```
CLIENT_CODE=FC-SB-15
CLIENT_KEY=6ea297bc5e294666f6738e1d48fa63d2

```

Feito isso o pacote já está pronto para ser utilizado.

Os endpoints a serem utilizados são os seguintes:

- `/api/v1/fpay/sales` (GET)
- `/api/v1/fpay/namedocument` (GET)
- `/api/v1/fpay/installments` (GET)

Os parâmetros que podem ser enviados são os mesmos para ambas as rotas, sendo eles os seguintes:

```
nu_referencia - (String | Max 20 caracteres)
nu_venda - (String | Max 20 caracteres)
page - (Integer)
per_page - (Integer)
dt_venda - (Date | YYYY-mm-dd)

```

Obs: Os parâmetros so opcionais.

Rotas de teste no Postman (collection)
--------------------------------------

[](#rotas-de-teste-no-postman-collection)

Para importar as rotas de teste criadas basta abrir o **Postman** acessar `File > Import > Raw Text` no menu superior e adicionar o seguinte texto:

```
{
	"info": {
		"_postman_id": "7c6ae951-c5d2-4f23-a2ea-783b0a55ba16",
		"name": "FpayModule",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Sales",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{url}}/api/v1/fpay/sales?nu_referencia=REF0001&nu_venda=38425-uGet3-2KFMj&page=0&per_page=10&dt_venda=2020-04-14",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"v1",
						"fpay",
						"sales"
					],
					"query": [
						{
							"key": "nu_referencia",
							"value": "REF0001"
						},
						{
							"key": "nu_venda",
							"value": "38425-uGet3-2KFMj"
						},
						{
							"key": "page",
							"value": "0"
						},
						{
							"key": "per_page",
							"value": "10"
						},
						{
							"key": "dt_venda",
							"value": "2020-04-14"
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "NameAndDocument",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{url}}/api/v1/fpay/namedocument?nu_referencia=REF0001&nu_venda=38425-uGet3-2KFMj&page=0&per_page=10&dt_venda=2020-04-14",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"v1",
						"fpay",
						"namedocument"
					],
					"query": [
						{
							"key": "nu_referencia",
							"value": "REF0001"
						},
						{
							"key": "nu_venda",
							"value": "38425-uGet3-2KFMj"
						},
						{
							"key": "page",
							"value": "0"
						},
						{
							"key": "per_page",
							"value": "10"
						},
						{
							"key": "dt_venda",
							"value": "2020-04-14"
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "Installments",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{url}}/api/v1/fpay/installments?nu_referencia=REF0001&nu_venda=38425-uGet3-2KFMj&page=0&per_page=10&dt_venda=2020-04-14",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"v1",
						"fpay",
						"installments"
					],
					"query": [
						{
							"key": "nu_referencia",
							"value": "REF0001"
						},
						{
							"key": "nu_venda",
							"value": "38425-uGet3-2KFMj"
						},
						{
							"key": "page",
							"value": "0"
						},
						{
							"key": "per_page",
							"value": "10"
						},
						{
							"key": "dt_venda",
							"value": "2020-04-14"
						}
					]
				}
			},
			"response": []
		}
	]
}

```

Após adicionar o JSON clicar em `Continue` e a collection será importada.

Feito isso deve criar uma variável URL com a rota base da sua aplicação, após ter feito isso os endpoints poderão ser requisitados.

Testes
------

[](#testes)

 [![](https://camo.githubusercontent.com/0085a91a4f139de32a1d4f063b9ad23829523316a9559ce0ff1c3c18956c861f/68747470733a2f2f7472656c6c6f2d6174746163686d656e74732e73332e616d617a6f6e6177732e636f6d2f3630616632336238383536376137376564613462363934312f373834783531382f61396435343738353664393637376362353862366431323334343065633438622f696d6167652e706e67)](https://camo.githubusercontent.com/0085a91a4f139de32a1d4f063b9ad23829523316a9559ce0ff1c3c18956c861f/68747470733a2f2f7472656c6c6f2d6174746163686d656e74732e73332e616d617a6f6e6177732e636f6d2f3630616632336238383536376137376564613462363934312f373834783531382f61396435343738353664393637376362353862366431323334343065633438622f696d6167652e706e67)

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity2

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity29

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/b788bedf1de59ab3530a65c4488da9d50dc4443f8f694b6e49ed7ed99eaad1be?d=identicon)[faustogmjunior](/maintainers/faustogmjunior)

---

Top Contributors

[![Fgamamarins](https://avatars.githubusercontent.com/u/29286898?v=4)](https://github.com/Fgamamarins "Fgamamarins (5 commits)")

### Embed Badge

![Health badge](/badges/fausto-src/health.svg)

```
[![Health](https://phpackages.com/badges/fausto-src/health.svg)](https://phpackages.com/packages/fausto-src)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
