Skip to content

Pillar Bank is a simulated banking application that interacts with a bank simulator to perform KYC checks, issue cards, and receive transactions via webhooks.

Notifications You must be signed in to change notification settings

artengin/Pillar-bank-laravel

Repository files navigation

Pillar Bank - backend

Pillar Bank is a simulated banking application that interacts with a Bank System Simulator to perform KYC checks, issue cards, and receive transactions via webhooks.

Actions Status

Project Setup

docker compose up --build

Set the following values in .env and .env.testing:

KYC_SECRET_KEY=
KYC_URL=
WEBHOOK_TRANSACTION_TOKEN_PILLARBANK_SECRET=

KYC_URL: Bank System Simulator

Features

🔐 User Authentication & KYC

  • User registration and KYC verification via external Bank Simulator
    POST /registration

  • JWT-based user authentication
    POST /login

  • Retrieve authenticated user's profile and linked cards
    GET /profile?with[]=cards

💳 Card Management

  • Issue a new bank card
    POST /cards

  • Get information about a specific card
    GET /cards/{id}

  • Filter and sort user cards
    GET /cards?order_by=id&desc=0

  • Reissue a card by ID
    POST /card/{id}/reissue

  • Freeze a card by ID
    PUT /cards/{id}/freeze

  • Unfreeze a card by ID
    PUT /cards/{id}/unfreeze

💸 Transactions

  • Receive and process transaction webhooks
    POST /webhook/transactions

  • A queued job is triggered to save the transaction to the database and update balances.
    The job runs in the background and doesn’t block the main request flow.

  • Get transaction details by ID
    GET /transactions/{id}

  • Retrieving a list of transactions for the authenticated user
    GET /transactions?card_id=1

📘 API Documentation

  • Automatic API documentation generation
    Powered by ronasit/laravel-swagger

system overview pillar bank

About

Pillar Bank is a simulated banking application that interacts with a bank simulator to perform KYC checks, issue cards, and receive transactions via webhooks.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages