Skip to content

a simple api for managing invoices, transactions, and balances with user authentication via Sanctum and PHPUnit testing

Notifications You must be signed in to change notification settings

lumamontes/laravel-payments-api

Repository files navigation

laravel payments api

image

simple api for managing transactions, invoices, and user balances


✨ Features

  • User Authentication – Token-based authentication with Laravel Sanctum.
  • Payments & Withdrawals – Handle user transactions, including deposits and withdrawals.
  • Invoice Management – Handle invoices creation and edit.
  • Balance Tracking – Update the user balances.

🚀 Installation

1 - Clone the Repository

git clone https://github.com/YOUR_USERNAME/laravel-payments-manager.git
cd laravel-payments-manager

2 - Install Dependencies

./vendor/bin/sail composer install

3 - Set Up Environment

cp .env.example .env
./vendor/bin/sail artisan key:generate

4 - Set Up Database

./vendor/bin/sail artisan migrate --seed

5 - Start the Server

./vendor/bin/sail up -d

Authentication

This project uses Laravel Sanctum for authentication. To access protected routes, include a Bearer Token in the request header.

Authorization: Bearer YOUR_ACCESS_TOKEN

API Endpoints

User Authentication

Method Endpoint Description
POST /api/login Log in and get a token
POST /api/logout Log out and revoke token

Transactions

Method Endpoint Description
POST /api/transactions Create a payment or withdrawal
GET /api/transactions Get user transactions

Invoices

Method Endpoint Description
POST /api/invoices Create an invoice
GET /api/invoices List all invoices
PUT /api/invoices/{id} Update an invoice
DELETE /api/invoices/{id} Delete an invoice

User Dashboard

Method Endpoint Description
GET /api/dashboard Return user financial dashboard

✅ Running Tests

image

To run PHPUnit tests:

./vendor/bin/sail artisan test

About

a simple api for managing invoices, transactions, and balances with user authentication via Sanctum and PHPUnit testing

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published