diff --git a/README.md b/README.md index c0c67e3..d823b74 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,10 @@ A complete transaction reporting service for Global Payments, providing interact ## Available Implementations -- [.NET Core](./dotnet/) - ASP.NET Core web application -- [Go](./go/) - Go HTTP server application -- [Java](./java/) - Jakarta EE servlet-based web application -- [Node.js](./nodejs/) - Express.js web application -- [PHP](./php/) - PHP web application -- [Python](./python/) - Flask web application +- [.NET Core](./dotnet/) - ([Preview](https://githubbox.com/globalpayments-samples/reporting-service/tree/main/dotnet)) - ASP.NET Core web application +- [Java](./java/) - ([Preview](https://githubbox.com/globalpayments-samples/reporting-service/tree/main/java)) - Jakarta EE servlet-based web application +- [Node.js](./nodejs/) - ([Preview](https://githubbox.com/globalpayments-samples/reporting-service/tree/main/nodejs)) - Express.js web application +- [PHP](./php/) - ([Preview](https://githubbox.com/globalpayments-samples/reporting-service/tree/main/php)) - PHP web application ## Features @@ -47,7 +45,7 @@ Each implementation includes comprehensive reporting features: ## Quick Start -1. **Choose your language** - Navigate to any implementation directory (nodejs, python, php, java, dotnet, go) +1. **Choose your language** - Navigate to any implementation directory (nodejs, php, java, dotnet) 2. **Set up credentials** - Copy `.env.sample` to `.env` and add your Global Payments API keys 3. **Install dependencies** - Run the installation command for your language (see individual READMEs) 4. **Start the server** - Execute `./run.sh` or use the language-specific run command @@ -71,7 +69,7 @@ This reporting service is ideal for: - Global Payments account with API credentials - Development environment for your chosen language -- Package manager (npm, pip, composer, maven, dotnet, go mod) +- Package manager (npm, composer, maven, dotnet) ## Docker Support @@ -87,10 +85,8 @@ docker-compose up # Services will be available at: # - Node.js: http://localhost:8001 -# - Python: http://localhost:8002 # - PHP: http://localhost:8003 # - Java: http://localhost:8004 -# - Go: http://localhost:8005 # - .NET: http://localhost:8006 ``` diff --git a/docker-compose.yml b/docker-compose.yml index 6017d28..0e05b4c 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -18,25 +18,6 @@ services: retries: 3 start_period: 30s - python: - build: - context: ./python - dockerfile: Dockerfile - ports: - - "8002:8000" - environment: - - PORT=8000 - - PUBLIC_API_KEY=${PUBLIC_API_KEY} - - SECRET_API_KEY=${SECRET_API_KEY} - networks: - - payments - healthcheck: - test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:8000/config"] - interval: 10s - timeout: 5s - retries: 3 - start_period: 30s - php: build: context: ./php @@ -73,25 +54,6 @@ services: retries: 3 start_period: 60s - go: - build: - context: ./go - dockerfile: Dockerfile - ports: - - "8005:8000" - environment: - - PORT=8000 - - PUBLIC_API_KEY=${PUBLIC_API_KEY} - - SECRET_API_KEY=${SECRET_API_KEY} - networks: - - payments - healthcheck: - test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:8000/config"] - interval: 10s - timeout: 5s - retries: 3 - start_period: 30s - dotnet: build: context: ./dotnet diff --git a/docker-run.sh b/docker-run.sh index 57e13e8..83fe04f 100755 --- a/docker-run.sh +++ b/docker-run.sh @@ -52,7 +52,7 @@ build_images() { start_services() { echo -e "${BLUE}🚀 Starting payment services...${NC}" - docker-compose up -d nodejs python php java go dotnet + docker-compose up -d nodejs php java dotnet echo -e "${YELLOW}⏳ Waiting for services to be healthy...${NC}" docker-compose ps @@ -61,10 +61,8 @@ start_services() { echo "" echo "Services available at:" echo " Node.js: http://localhost:8001" - echo " Python: http://localhost:8002" echo " PHP: http://localhost:8003" echo " Java: http://localhost:8004" - echo " Go: http://localhost:8005" echo " .NET: http://localhost:8006" } @@ -82,7 +80,7 @@ run_tests() { # Start services if not running echo -e "${YELLOW}📋 Ensuring services are running...${NC}" - docker-compose up -d nodejs python php java go dotnet + docker-compose up -d nodejs php java dotnet # Wait for services to be healthy echo -e "${YELLOW}⏳ Waiting for services to be ready...${NC}" @@ -99,7 +97,7 @@ run_tests() { run_single_test() { local impl=$1 if [ -z "$impl" ]; then - echo -e "${RED}❌ Please specify implementation: nodejs, python, php, java, go, or dotnet${NC}" + echo -e "${RED}❌ Please specify implementation: nodejs, php, java, or dotnet${NC}" exit 1 fi diff --git a/dotnet/.codesandbox/tasks.json b/dotnet/.codesandbox/tasks.json new file mode 100644 index 0000000..d4e9eb0 --- /dev/null +++ b/dotnet/.codesandbox/tasks.json @@ -0,0 +1,29 @@ +{ + // These tasks will run in order when initializing your CodeSandbox project. + "setupTasks": [ + { + "name": "Install Dependencies", + "command": "dotnet restore" + }, + { + "name": "Create .env", + "command": "cp .env.sample .env" + } + ], + + // These tasks can be run from CodeSandbox. Running one will open a log in the app. + "tasks": { + "start": { + "name": "start", + "command": "dotnet watch -- run", + "runAtStart": true, + "preview": { + "port": 8000 + } + }, + "install": { + "name": "install dependencies", + "command": "dotnet restore" + } + } +} diff --git a/dotnet/.codesandbox/template.json b/dotnet/.codesandbox/template.json new file mode 100644 index 0000000..d70df61 --- /dev/null +++ b/dotnet/.codesandbox/template.json @@ -0,0 +1,7 @@ +{ + "title": "Global Payments C#", + "description": "The easiest way to get started from Docker in CodeSandbox", + "iconUrl": "https://globalpayments-samples.github.io/assets/img/g-symbol-dev-brand.png", + "tags": ["global-payments", "sample", "csharp"], + "published": false +} \ No newline at end of file diff --git a/dotnet/.devcontainer/devcontainer.json b/dotnet/.devcontainer/devcontainer.json new file mode 100644 index 0000000..fffb453 --- /dev/null +++ b/dotnet/.devcontainer/devcontainer.json @@ -0,0 +1,4 @@ +{ + "name": "Devcontainer", + "image": "mcr.microsoft.com/devcontainers/dotnet" +} diff --git a/dotnet/.env.sample b/dotnet/.env.sample index 9b3b549..e8057f3 100644 --- a/dotnet/.env.sample +++ b/dotnet/.env.sample @@ -1,4 +1,6 @@ # API Keys for Global Payments # Replace these sample values with your actual API keys -PUBLIC_API_KEY=pkapi_your_public_key_here -SECRET_API_KEY=skapi_your_secret_key_here + +# API Platform (GP API) +GP_API_APP_ID=4gPqnGBkppGYvoE5UX9EWQlotTxGUDbs #gitleaks:allow +GP_API_APP_KEY=FQyJA5VuEQfcji2M #gitleaks:allow \ No newline at end of file diff --git a/go/.env.sample b/go/.env.sample deleted file mode 100644 index 9b3b549..0000000 --- a/go/.env.sample +++ /dev/null @@ -1,4 +0,0 @@ -# API Keys for Global Payments -# Replace these sample values with your actual API keys -PUBLIC_API_KEY=pkapi_your_public_key_here -SECRET_API_KEY=skapi_your_secret_key_here diff --git a/go/.gitignore b/go/.gitignore deleted file mode 100644 index c79514e..0000000 --- a/go/.gitignore +++ /dev/null @@ -1,28 +0,0 @@ -# Binaries for programs and plugins -*.exe -*.exe~ -*.dll -*.so -*.dylib - -# Test binary, built with `go test -c` -*.test - -# Output of the go coverage tool, specifically when used with LiteIDE -*.out - -# Environment files -.env - -# IDE specific files -.idea -.vscode -*.swp -*.swo - -# OS generated files -.DS_Store -.DS_Store? -._* -.Spotlight-V100 -.Trashes diff --git a/go/Dockerfile b/go/Dockerfile deleted file mode 100644 index e8399cc..0000000 --- a/go/Dockerfile +++ /dev/null @@ -1,32 +0,0 @@ -FROM golang:1.23-alpine AS builder - -WORKDIR /app - -# Copy go mod files and download dependencies -COPY go.mod go.sum ./ -RUN go mod download - -# Copy source code and build -COPY . . -RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o main . - -# Runtime stage -FROM alpine:latest - -WORKDIR /app - -# Install ca-certificates for HTTPS calls -RUN apk --no-cache add ca-certificates - -# Copy the binary from builder stage -COPY --from=builder /app/main . -COPY --from=builder /app/static ./static - -# Create non-root user -RUN addgroup -g 1001 -S appuser && \ - adduser -S appuser -u 1001 -USER appuser - -EXPOSE 8000 - -CMD ["./main"] \ No newline at end of file diff --git a/go/README.md b/go/README.md deleted file mode 100644 index d713b66..0000000 --- a/go/README.md +++ /dev/null @@ -1,196 +0,0 @@ -# Global Payments Go Integration - -A comprehensive Go implementation for Global Payments payment processing and transaction reporting using the Global Payments Go SDK. - -## Requirements - -- Go 1.21 or later -- Global Payments account and API credentials - -## Quick Start - -### 1. Configure Credentials - -Copy `.env.sample` to `.env` and add your credentials: - -```properties -# Payment Processing (Portico API) -PUBLIC_API_KEY=pkapi_cert_your_public_key -SECRET_API_KEY=skapi_cert_your_secret_key - -# Transaction Reporting (GP-API) -GP_API_APP_ID=your_app_id_here -GP_API_APP_KEY=your_app_key_here -GP_API_ENVIRONMENT=TEST # or PRODUCTION -``` - -### 2. Install Dependencies - -```bash -go mod download -``` - -### 3. Start the Server - -```bash -go run main.go -``` - -The application will start on `http://localhost:8888` - -### 4. Verify Setup - -Open your browser to: -- **Web Interface**: http://localhost:8888/ -- **Get Public Key**: http://localhost:8888/config -- **Reporting Config**: http://localhost:8888/reports/config - -## Features - -### ✅ Payment Processing -- Process card payments with hosted fields tokenization -- Support for billing address verification (AVS) -- Real-time payment processing with Global Payments Portico API - -### ✅ Transaction Reporting -- Search and filter transactions -- Export data (JSON, CSV, XML) -- Generate settlement, dispute, and deposit reports -- Transaction analytics and summaries - -## API Endpoints - -### Payment Processing - -**Get Configuration** -```bash -curl http://localhost:8888/config -``` - -**Process Payment** -```bash -curl -X POST http://localhost:8888/process-payment \ - -H "Content-Type: application/json" \ - -d '{"payment_token":"YOUR_TOKEN","billing_zip":"12345","amount":"25.00"}' -``` - -### Transaction Reporting - -See [REPORTING_README.md](REPORTING_README.md) for complete reporting API documentation. - -**Quick Example - Search Transactions** -```bash -curl "http://localhost:8888/reports/search?start_date=2025-09-01&page_size=10" -``` - -## Project Structure - -``` -go/ -├── main.go # Main application -├── reporting_service.go # Reporting service logic -├── reports.go # Reporting API endpoints -├── main_reporting.go # Reporting server setup -├── static/ -│ └── index.html # Payment form UI -├── go.mod # Go dependencies -├── .env # Your credentials (not in git) -├── .env.sample # Credential template -├── README.md # This file -└── REPORTING_README.md # Reporting API documentation -``` - -## Usage - -### Processing a Payment - -1. Open http://localhost:8888/ in your browser -2. Use test card: `4263970000005262` -3. Enter any future expiration date -4. Enter CVV: `123` -5. Enter billing ZIP code -6. Click "Pay $10.00" - -### Searching Transactions - -After processing payments, search for them: - -```bash -curl "http://localhost:8888/reports/search?page_size=20" -``` - -### Exporting Data - -Export transactions to CSV: - -```bash -curl "http://localhost:8888/reports/export?format=csv&start_date=2025-09-01" -o transactions.csv -``` - -## Testing - -### Test Card Numbers - -| Card Type | Number | CVV | Expiry | -|-----------|--------|-----|--------| -| Visa | 4263970000005262 | 123 | Any future date | -| Mastercard | 5425230000004415 | 123 | Any future date | -| Amex | 374101000000608 | 1234 | Any future date | - -### Testing Workflow - -1. **Process a payment** using the web interface -2. **Verify transaction** appears in reporting: - ```bash - curl "http://localhost:8888/reports/search" - ``` -3. **Get transaction details**: - ```bash - curl "http://localhost:8888/reports/detail?transaction_id=TRN_xxx" - ``` - -## Environment Variables - -| Variable | Required | Description | -|----------|----------|-------------| -| `PUBLIC_API_KEY` | Yes | Portico public API key for payment processing | -| `SECRET_API_KEY` | Yes | Portico secret API key for payment processing | -| `GP_API_APP_ID` | Yes | GP-API App ID for reporting | -| `GP_API_APP_KEY` | Yes | GP-API App Key for reporting | -| `GP_API_ENVIRONMENT` | No | TEST or PRODUCTION (default: TEST) | - -## Troubleshooting - -**Port already in use?** -```bash -# Modify the port in main.go or main_reporting.go -``` - -**Missing credentials error?** -- Ensure `.env` file exists in the `go/` directory -- Verify all required credentials are set -- Check for trailing spaces in credential values - -**Payment processing fails?** -- Verify `PUBLIC_API_KEY` and `SECRET_API_KEY` are correct -- Ensure using test credentials for test environment - -**Reporting not working?** -- Verify `GP_API_APP_ID` and `GP_API_APP_KEY` are correct -- These are different from payment processing credentials - -**Module errors?** -- Run `go mod tidy` to clean up dependencies -- Ensure Go 1.21+ is installed - -## Documentation - -- **Payment Processing**: See API Endpoints section above -- **Transaction Reporting**: See [REPORTING_README.md](REPORTING_README.md) -- **Global Payments Docs**: https://developer.globalpay.com - -## Support - -For issues or questions: -- Global Payments Developer Portal: https://developer.globalpay.com -- SDK Documentation: https://github.com/globalpayments/go-sdk diff --git a/go/REPORTING_README.md b/go/REPORTING_README.md deleted file mode 100644 index de5246f..0000000 --- a/go/REPORTING_README.md +++ /dev/null @@ -1,276 +0,0 @@ -# Global Payments Reporting API - Go - -A comprehensive reporting service for Global Payments transactions with search, filtering, analytics, and data export capabilities. - -## Quick Start - -### 1. Configure Environment - -Create a `.env` file in the go directory: - -```properties -GP_API_APP_ID=your_app_id_here -GP_API_APP_KEY=your_app_key_here -GP_API_ENVIRONMENT=TEST # or PRODUCTION -``` - -### 2. Install Dependencies & Start Server - -```bash -cd go -go mod tidy -go run reporting_service.go reports.go main_reporting.go -``` - -The API will be available at `http://localhost:8080/reports` - -### 3. Verify Configuration - -```bash -curl "http://localhost:8080/reports/config" -``` - -## API Endpoints - -All endpoints use `/reports/{action}` or `/reports?action={action_name}` and support both GET and POST requests. - -### Search Transactions - -Search and filter transactions with pagination. - -```bash -curl "http://localhost:8080/reports/search?start_date=2025-09-01&end_date=2025-09-30&page_size=20" -``` - -**Parameters**: -- `page` - Page number (default: 1) -- `page_size` - Results per page (default: 10, max: 100) -- `start_date` - Start date (YYYY-MM-DD) -- `end_date` - End date (YYYY-MM-DD) -- `transaction_id` - Specific transaction ID -- `payment_type` - Payment type filter -- `status` - Transaction status -- `amount_min` - Minimum amount -- `amount_max` - Maximum amount -- `card_last_four` - Last 4 digits of card - -### Get Transaction Details - -Retrieve detailed information for a specific transaction. - -```bash -curl "http://localhost:8080/reports/detail?transaction_id=TRN_123456" -``` - -**Required**: `transaction_id` - -### Settlement Report - -Get settlement information for a date range. - -```bash -curl "http://localhost:8080/reports/settlement?start_date=2025-09-01&end_date=2025-09-30" -``` - -**Parameters**: -- `page`, `page_size` - Pagination -- `start_date`, `end_date` - Date range - -### Export Transactions - -Export transaction data in JSON, CSV, or XML format. - -**CSV Export**: -```bash -curl "http://localhost:8080/reports/export?format=csv&start_date=2025-09-01&end_date=2025-09-30" -o transactions.csv -``` - -**XML Export**: -```bash -curl "http://localhost:8080/reports/export?format=xml&start_date=2025-09-01&end_date=2025-09-30" -o transactions.xml -``` - -**JSON Export**: -```bash -curl "http://localhost:8080/reports/export?format=json&start_date=2025-09-01&end_date=2025-09-30" -``` - -**Parameters**: -- `format` - Export format: `json`, `csv`, or `xml` (required) -- Plus all search filters - -### Summary Statistics - -Get aggregate statistics for transactions. - -```bash -curl "http://localhost:8080/reports/summary?start_date=2025-09-01&end_date=2025-09-30" -``` - -**Returns**: -- Total transaction count -- Total amount -- Average amount -- Status breakdown -- Payment type breakdown - -### Dispute Report - -Get dispute information with filtering. - -```bash -curl "http://localhost:8080/reports/disputes?start_date=2025-09-01&end_date=2025-09-30" -``` - -**Parameters**: -- `page`, `page_size` - Pagination -- `start_date`, `end_date` - Date range -- `stage` - Dispute stage -- `status` - Dispute status - -**Get Dispute Details**: -```bash -curl "http://localhost:8080/reports/dispute/DIS_123456" -``` - -### Deposit Report - -Get deposit information and details. - -```bash -curl "http://localhost:8080/reports/deposits?start_date=2025-09-01&end_date=2025-09-30" -``` - -**Parameters**: -- `page`, `page_size` - Pagination -- `start_date`, `end_date` - Date range -- `deposit_id` - Filter by deposit ID -- `status` - Deposit status - -**Get Deposit Details**: -```bash -curl "http://localhost:8080/reports/deposit/DEP_123456" -``` - -### Declined Transactions Report - -Get declined transactions with analysis. - -```bash -curl "http://localhost:8080/reports/declines?start_date=2025-09-01&end_date=2025-09-30" -``` - -**Returns** transaction data plus decline analysis: -- Decline reasons breakdown -- Card type breakdown -- Hourly decline patterns - -### Comprehensive Date Range Report - -Get a combined report across all transaction types. - -```bash -curl "http://localhost:8080/reports/date-range?start_date=2025-09-01&end_date=2025-09-30&transaction_limit=100" -``` - -**Parameters**: -- `start_date`, `end_date` - Date range -- `transaction_limit` - Max transactions (default: 100, max: 1000) -- `settlement_limit` - Max settlements (default: 50, max: 500) -- `dispute_limit` - Max disputes (default: 25, max: 100) -- `deposit_limit` - Max deposits (default: 25, max: 100) - -**Returns**: -- Transactions -- Settlements -- Disputes -- Deposits -- Comprehensive summary - -### Batch Report - -Get batch report information. - -```bash -curl "http://localhost:8080/reports/batches?start_date=2025-09-01&end_date=2025-09-30" -``` - -## Response Format - -### Success Response - -```json -{ - "success": true, - "data": { - "transactions": [...], - "pagination": { - "page": 1, - "page_size": 10, - "total_count": 42 - } - }, - "timestamp": "2025-10-01 12:00:00" -} -``` - -### Error Response - -```json -{ - "success": false, - "error": { - "code": "ERROR_CODE", - "message": "Error description", - "timestamp": "2025-10-01 12:00:00" - } -} -``` - -## Common Use Cases - -### Daily Transaction Report - -```bash -curl "http://localhost:8080/reports/summary?start_date=2025-09-30&end_date=2025-09-30" -``` - -### Find Specific Transaction - -```bash -curl "http://localhost:8080/reports/search?transaction_id=TRN_abc123" -``` - -### Export Monthly Transactions - -```bash -curl "http://localhost:8080/reports/export?format=csv&start_date=2025-09-01&end_date=2025-09-30" -o september_transactions.csv -``` - -### Analyze Declines - -```bash -curl "http://localhost:8080/reports/declines?start_date=2025-09-01&end_date=2025-09-30" -``` - -### Check Settlement Status - -```bash -curl "http://localhost:8080/reports/settlement?start_date=2025-09-30" -``` - -## Notes - -- **Date Format**: All dates must be in `YYYY-MM-DD` format -- **Pagination**: Page size is limited to 100 items maximum -- **Export Limits**: Exports are capped at 1000 transactions -- **Timestamps**: All response timestamps use `YYYY-MM-DD HH:mm:ss` format -- **CORS**: Enabled for cross-origin requests - -## API Documentation - -View complete API documentation: - -```bash -curl http://localhost:8080/reports -``` diff --git a/go/go.mod b/go/go.mod deleted file mode 100644 index cae050b..0000000 --- a/go/go.mod +++ /dev/null @@ -1,19 +0,0 @@ -module github.com/globalpayments/card-payments-go - -go 1.23.4 - -require ( - github.com/globalpayments/go-sdk v1.1.3 - github.com/gorilla/mux v1.8.1 - github.com/joho/godotenv v1.5.1 -) - -require ( - github.com/antchfx/xmlquery v1.3.18 // indirect - github.com/antchfx/xpath v1.2.4 // indirect - github.com/araddon/dateparse v0.0.0-20210429162001-6b43995a97de // indirect - github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect - github.com/shopspring/decimal v1.3.1 // indirect - golang.org/x/net v0.7.0 // indirect - golang.org/x/text v0.7.0 // indirect -) diff --git a/go/go.sum b/go/go.sum deleted file mode 100644 index e0de448..0000000 --- a/go/go.sum +++ /dev/null @@ -1,56 +0,0 @@ -github.com/antchfx/xmlquery v1.3.18 h1:FSQ3wMuphnPPGJOFhvc+cRQ2CT/rUj4cyQXkJcjOwz0= -github.com/antchfx/xmlquery v1.3.18/go.mod h1:Afkq4JIeXut75taLSuI31ISJ/zeq+3jG7TunF7noreA= -github.com/antchfx/xpath v1.2.4 h1:dW1HB/JxKvGtJ9WyVGJ0sIoEcqftV3SqIstujI+B9XY= -github.com/antchfx/xpath v1.2.4/go.mod h1:i54GszH55fYfBmoZXapTHN8T8tkcHfRgLyVwwqzXNcs= -github.com/araddon/dateparse v0.0.0-20210429162001-6b43995a97de h1:FxWPpzIjnTlhPwqqXc4/vE0f7GvRjuAsbW+HOIe8KnA= -github.com/araddon/dateparse v0.0.0-20210429162001-6b43995a97de/go.mod h1:DCaWoUhZrYW9p1lxo/cm8EmUOOzAPSEZNGF2DK1dJgw= -github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= -github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/globalpayments/go-sdk v1.1.3 h1:7K966xL/GL3SHSGwOiEX+QxPK5jbJvuh/Mn0WcwNCPA= -github.com/globalpayments/go-sdk v1.1.3/go.mod h1:DCA8qrRhmOFbcN4akP+Rhw1WiLTf45duuO2mX6jOwhU= -github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE= -github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= -github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= -github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= -github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= -github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= -github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= -github.com/scylladb/termtables v0.0.0-20191203121021-c4c0b6d42ff4/go.mod h1:C1a7PQSMz9NShzorzCiG2fk9+xuCgLkPeCvMHYR2OWg= -github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5gKV8= -github.com/shopspring/decimal v1.3.1/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o= -github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= -github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= -golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= -golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= -golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= -golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= -golang.org/x/net v0.7.0 h1:rJrUqqhjsgNp7KqAIc25s9pZnjU7TUcSY7HcVZjdn1g= -golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= -golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= -golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= -golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= -golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= -golang.org/x/text v0.7.0 h1:4BRB4x83lYWy72KwLD/qYDuTu7q9PjSagHvijDw7cLo= -golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= -golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= -gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/go/main.go b/go/main.go deleted file mode 100644 index ed6b469..0000000 --- a/go/main.go +++ /dev/null @@ -1,218 +0,0 @@ -// Package main implements a card payment processing server using the Global Payments SDK. -// It provides endpoints for configuration and payment processing, handling tokenized -// card data to ensure secure payment processing. -package main - -import ( - "context" - "encoding/json" - "log" - "net/http" - "os" - "regexp" - "strconv" - - "github.com/globalpayments/go-sdk/api" - "github.com/globalpayments/go-sdk/api/entities/base" - "github.com/globalpayments/go-sdk/api/entities/transactions" - "github.com/globalpayments/go-sdk/api/paymentmethods" - "github.com/globalpayments/go-sdk/api/serviceconfigs" - "github.com/globalpayments/go-sdk/api/utils/stringutils" - "github.com/joho/godotenv" -) - -// Config represents the configuration response sent to the client -type Config struct { - PublicApiKey string `json:"publicApiKey"` -} - -// Response represents a standardized API response -type Response struct { - Success bool `json:"success"` - Message string `json:"message,omitempty"` - Data interface{} `json:"data,omitempty"` - Error *ErrorInfo `json:"error,omitempty"` -} - -// ErrorInfo represents error details in the response -type ErrorInfo struct { - Code string `json:"code"` - Details string `json:"details"` -} - -// PaymentRequest represents the expected payment processing request payload -type PaymentRequest struct { - PaymentToken string `json:"payment_token"` - BillingZip string `json:"billing_zip"` -} - -// sanitizePostalCode removes invalid characters from the postal code input. -// It only allows alphanumeric characters and hyphens, limiting the length to 10 characters. -// This handles both US (12345, 12345-6789) and international postal codes. -func sanitizePostalCode(postalCode string) string { - // Remove any characters that aren't alphanumeric or hyphen - reg := regexp.MustCompile("[^a-zA-Z0-9-]") - sanitized := reg.ReplaceAllString(postalCode, "") - // Limit length to 10 characters - if len(sanitized) > 10 { - return sanitized[:10] - } - return sanitized -} - -// handleConfig handles the /config endpoint -func handleConfig(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - response := Response{ - Success: true, - Data: Config{ - PublicApiKey: os.Getenv("PUBLIC_API_KEY"), - }, - } - json.NewEncoder(w).Encode(response) -} - -// handlePayment handles the /process-payment endpoint -func handlePayment(w http.ResponseWriter, r *http.Request) { - // Ensure endpoint only accepts POST requests - if r.Method != http.MethodPost { - http.Error(w, "Method not allowed", http.StatusMethodNotAllowed) - return - } - - // Parse and validate the form data - if err := r.ParseForm(); err != nil { - http.Error(w, "Error parsing form data", http.StatusBadRequest) - return - } - - // Extract payment information from form - paymentToken := r.Form.Get("payment_token") - billingZip := r.Form.Get("billing_zip") - amountStr := r.Form.Get("amount") - - // Validate required fields are present - if paymentToken == "" || billingZip == "" || amountStr == "" { - w.Header().Set("Content-Type", "application/json") - errorResponse := Response{ - Success: false, - Message: "Payment processing failed", - Error: &ErrorInfo{ - Code: "VALIDATION_ERROR", - Details: "Missing required fields", - }, - } - w.WriteHeader(http.StatusBadRequest) - json.NewEncoder(w).Encode(errorResponse) - return - } - - // Validate and parse amount - amount, err := strconv.ParseFloat(amountStr, 64) - if err != nil || amount <= 0 { - w.Header().Set("Content-Type", "application/json") - errorResponse := Response{ - Success: false, - Message: "Payment processing failed", - Error: &ErrorInfo{ - Code: "VALIDATION_ERROR", - Details: "Amount must be a positive number", - }, - } - w.WriteHeader(http.StatusBadRequest) - json.NewEncoder(w).Encode(errorResponse) - return - } - - // Initialize payment data using tokenized card information - card := paymentmethods.NewCreditCardDataWithToken(paymentToken) - - // Create billing address for AVS verification - address := base.NewAddress(sanitizePostalCode(billingZip)) - - // Configure the payment transaction using the provided amount - amountStr = strconv.FormatFloat(amount, 'f', 2, 64) - val, _ := stringutils.ToDecimalAmount(amountStr) - transaction := card.ChargeWithAmount(val) - transaction.WithAllowDuplicates(true) - transaction.WithCurrency("USD") - transaction.WithAddress(address) - - ctx := context.Background() - response, err := api.ExecuteGateway[transactions.Transaction](ctx, transaction) - if err != nil { - w.Header().Set("Content-Type", "application/json") - errorResponse := Response{ - Success: false, - Message: "Internal server error", - Error: &ErrorInfo{ - Code: "SERVER_ERROR", - Details: err.Error(), - }, - } - w.WriteHeader(http.StatusInternalServerError) - json.NewEncoder(w).Encode(errorResponse) - return - } - - // Check for successful response code - if response.GetResponseCode() != "00" { - w.Header().Set("Content-Type", "application/json") - errorResponse := Response{ - Success: false, - Message: "Payment processing failed", - Error: &ErrorInfo{ - Code: "PAYMENT_DECLINED", - Details: response.GetResponseMessage(), - }, - } - w.WriteHeader(http.StatusBadRequest) - json.NewEncoder(w).Encode(errorResponse) - return - } - - w.Header().Set("Content-Type", "application/json") - successResponse := Response{ - Success: true, - Message: "Payment successful! Transaction ID: " + response.GetTransactionId(), - Data: map[string]string{ - "transactionId": response.GetTransactionId(), - }, - } - json.NewEncoder(w).Encode(successResponse) -} - -func main() { - // Initialize environment configuration - err := godotenv.Load() - if err != nil { - log.Fatal("Error loading .env file") - } - - // Configure Global Payments SDK with credentials and settings - config := serviceconfigs.NewPorticoConfig() - config.SecretApiKey = os.Getenv("SECRET_API_KEY") - config.DeveloperId = "000000" - config.VersionNumber = "0000" - config.ServiceUrl = "https://cert.api2.heartlandportico.com" - - err = api.ConfigureService(config, "default") - if err != nil { - log.Fatal("Error configuring Global Payments service:", err) - } - - // Set up routes - http.Handle("/", http.FileServer(http.Dir("static"))) - http.Handle("/config", http.HandlerFunc(handleConfig)) - http.Handle("/process-payment", http.HandlerFunc(handlePayment)) - - // Get port from environment variable or use default - port := os.Getenv("PORT") - if port == "" { - port = "8000" - } - - log.Printf("Server starting on http://localhost:%s", port) - log.Printf("Server also accessible at http://127.0.0.1:%s", port) - log.Fatal(http.ListenAndServe("0.0.0.0:"+port, nil)) -} diff --git a/go/main_reporting.go b/go/main_reporting.go deleted file mode 100644 index f988362..0000000 --- a/go/main_reporting.go +++ /dev/null @@ -1,77 +0,0 @@ -// Package main implements an example server that combines payment processing -// and reporting functionality using the Global Payments SDK. -// -// This example shows how to integrate the reporting service alongside -// the existing payment processing endpoints. -// -// Usage: -// To run the reporting service only: -// go run reporting_service.go reports.go main_reporting.go -// -// The server will start on port 8080 by default (configurable via PORT env var) -package main - -import ( - "log" - "net/http" - "os" - - "github.com/gorilla/mux" - "github.com/joho/godotenv" -) - -func main() { - // Load environment variables - if err := godotenv.Load(); err != nil { - log.Println("Warning: .env file not found, using system environment variables") - } - - // Create router - router := mux.NewRouter() - - // Initialize reporting API routes - if err := InitializeReportingAPI(router); err != nil { - log.Fatalf("Failed to initialize reporting API: %v", err) - } - - // Optional: Add a health check endpoint - router.HandleFunc("/health", func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.WriteHeader(http.StatusOK) - w.Write([]byte(`{"status":"healthy","service":"reporting-api"}`)) - }).Methods("GET") - - // Get port from environment or use default - port := os.Getenv("PORT") - if port == "" { - port = "8080" - } - - // Start server - log.Printf("=================================================") - log.Printf("Global Payments Reporting API Server") - log.Printf("=================================================") - log.Printf("Server starting on http://localhost:%s", port) - log.Printf("API Documentation: http://localhost:%s/reports", port) - log.Printf("Health Check: http://localhost:%s/health", port) - log.Printf("=================================================") - log.Printf("") - log.Printf("Available Endpoints:") - log.Printf(" GET /reports - API documentation") - log.Printf(" GET /reports/config - Configuration status") - log.Printf(" GET /reports/search - Search transactions") - log.Printf(" GET /reports/detail - Transaction details") - log.Printf(" GET /reports/settlement - Settlement report") - log.Printf(" GET /reports/export - Export transactions") - log.Printf(" GET /reports/summary - Summary statistics") - log.Printf(" GET /reports/disputes - Dispute report") - log.Printf(" GET /reports/deposits - Deposit report") - log.Printf(" GET /reports/batches - Batch report") - log.Printf(" GET /reports/declines - Declined transactions") - log.Printf(" GET /reports/date-range - Date range report") - log.Printf("=================================================") - - if err := http.ListenAndServe("0.0.0.0:"+port, router); err != nil { - log.Fatalf("Server failed to start: %v", err) - } -} \ No newline at end of file diff --git a/go/reporting_service.go b/go/reporting_service.go deleted file mode 100644 index 09f6363..0000000 --- a/go/reporting_service.go +++ /dev/null @@ -1,1048 +0,0 @@ -// Package main provides the core reporting service functionality for Global Payments. -// This service class provides comprehensive reporting functionality including -// search, filtering, dispute management, deposits, batches, and data export. -package main - -import ( - "context" - "encoding/csv" - "encoding/json" - "encoding/xml" - "fmt" - "os" - "strconv" - "strings" - "time" - - "github.com/globalpayments/go-sdk/api" - "github.com/globalpayments/go-sdk/api/builders" - "github.com/globalpayments/go-sdk/api/entities/enums/channel" - "github.com/globalpayments/go-sdk/api/entities/enums/environment" - "github.com/globalpayments/go-sdk/api/entities/enums/paymenttype" - "github.com/globalpayments/go-sdk/api/entities/enums/transactionstatus" - "github.com/globalpayments/go-sdk/api/entities/reporting" - "github.com/globalpayments/go-sdk/api/serviceconfigs" - "github.com/joho/godotenv" -) - -// ReportingService provides methods for transaction reporting, searching, and data export -type ReportingService struct { - isConfigured bool -} - -// TransactionInfo represents formatted transaction data -type TransactionInfo struct { - TransactionID string `json:"transaction_id" csv:"transaction_id" xml:"transaction_id"` - Timestamp string `json:"timestamp" csv:"timestamp" xml:"timestamp"` - Amount float64 `json:"amount" csv:"amount" xml:"amount"` - Currency string `json:"currency" csv:"currency" xml:"currency"` - Status string `json:"status" csv:"status" xml:"status"` - PaymentMethod string `json:"payment_method" csv:"payment_method" xml:"payment_method"` - CardLastFour string `json:"card_last_four" csv:"card_last_four" xml:"card_last_four"` - AuthCode string `json:"auth_code" csv:"auth_code" xml:"auth_code"` - ReferenceNumber string `json:"reference_number" csv:"reference_number" xml:"reference_number"` -} - -// TransactionDetails represents detailed transaction information -type TransactionDetails struct { - TransactionID string `json:"transaction_id"` - Timestamp string `json:"timestamp"` - Amount float64 `json:"amount"` - Currency string `json:"currency"` - Status string `json:"status"` - PaymentMethod string `json:"payment_method"` - CardDetails map[string]string `json:"card_details"` - AuthCode string `json:"auth_code"` - ReferenceNumber string `json:"reference_number"` - GatewayResponseCode string `json:"gateway_response_code"` - GatewayResponseMessage string `json:"gateway_response_message"` -} - -// SettlementInfo represents settlement data -type SettlementInfo struct { - SettlementID string `json:"settlement_id"` - SettlementDate string `json:"settlement_date"` - TransactionCount int `json:"transaction_count"` - TotalAmount float64 `json:"total_amount"` - Currency string `json:"currency"` - Status string `json:"status"` -} - -// DisputeInfo represents dispute data -type DisputeInfo struct { - DisputeID string `json:"dispute_id"` - TransactionID string `json:"transaction_id"` - CaseNumber string `json:"case_number"` - DisputeStage string `json:"dispute_stage"` - DisputeStatus string `json:"dispute_status"` - CaseAmount float64 `json:"case_amount"` - Currency string `json:"currency"` - ReasonCode string `json:"reason_code"` - ReasonDescription string `json:"reason_description"` - CaseTime string `json:"case_time"` - LastAdjustmentTime string `json:"last_adjustment_time"` -} - -// DepositInfo represents deposit data -type DepositInfo struct { - DepositID string `json:"deposit_id"` - DepositDate string `json:"deposit_date"` - DepositReference string `json:"deposit_reference"` - DepositStatus string `json:"deposit_status"` - DepositAmount float64 `json:"deposit_amount"` - Currency string `json:"currency"` - MerchantNumber string `json:"merchant_number"` - MerchantHierarchy string `json:"merchant_hierarchy"` - SalesCount int `json:"sales_count"` - SalesAmount float64 `json:"sales_amount"` - RefundsCount int `json:"refunds_count"` - RefundsAmount float64 `json:"refunds_amount"` -} - -// BatchInfo represents batch data -type BatchInfo struct { - BatchID string `json:"batch_id"` - SequenceNumber string `json:"sequence_number"` - TransactionCount int `json:"transaction_count"` - TotalAmount float64 `json:"total_amount"` - Currency string `json:"currency"` - BatchStatus string `json:"batch_status"` - CloseTime string `json:"close_time"` - OpenTime string `json:"open_time"` -} - -// Pagination represents pagination information -type Pagination struct { - Page int `json:"page"` - PageSize int `json:"page_size"` - TotalCount int `json:"total_count"` - OriginalTotalCount int `json:"original_total_count,omitempty"` -} - -// NewReportingService creates a new reporting service instance -func NewReportingService() (*ReportingService, error) { - service := &ReportingService{} - if err := service.configureSDK(); err != nil { - return nil, fmt.Errorf("failed to configure SDK: %w", err) - } - service.isConfigured = true - return service, nil -} - -// configureSDK initializes the Global Payments SDK for GP-API -func (rs *ReportingService) configureSDK() error { - // Load environment variables - if err := godotenv.Load(); err != nil { - // Not a fatal error - env vars might be set externally - } - - // Validate required environment variables - appID := os.Getenv("GP_API_APP_ID") - appKey := os.Getenv("GP_API_APP_KEY") - - if appID == "" || appKey == "" { - return fmt.Errorf("missing required environment variables: GP_API_APP_ID and GP_API_APP_KEY") - } - - // Configure GP-API - config := serviceconfigs.NewGpApiConfig() - config.AppId = appID - config.AppKey = appKey - config.Environment = environment.TEST // Change to PRODUCTION for live - config.Channel = channel.CardNotPresent - - return api.ConfigureService(config, "default") -} - -// SearchTransactions searches transactions with filters and pagination -func (rs *ReportingService) SearchTransactions(filters map[string]interface{}) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - ctx := context.Background() - - // Extract pagination parameters - page := getIntValue(filters, "page", 1) - pageSize := getIntValue(filters, "page_size", 10) - if pageSize > 100 { - pageSize = 100 - } - - // Build search criteria - searchBuilder := builders.NewReportBuilder(builders.TransactionReportType) - searchBuilder.WithPaging(page, pageSize) - - // Apply date range filters - if startDate, ok := filters["start_date"].(string); ok && startDate != "" { - if date, err := time.Parse("2006-01-02", startDate); err == nil { - searchBuilder.WithStartDate(date) - } - } - - if endDate, ok := filters["end_date"].(string); ok && endDate != "" { - if date, err := time.Parse("2006-01-02", endDate); err == nil { - searchBuilder.WithEndDate(date) - } - } - - // Apply transaction ID filter - if txnID, ok := filters["transaction_id"].(string); ok && txnID != "" { - searchBuilder.WithTransactionId(txnID) - } - - // Apply payment type filter - if paymentTypeStr, ok := filters["payment_type"].(string); ok && paymentTypeStr != "" { - if pt := mapPaymentType(paymentTypeStr); pt != "" { - searchBuilder.WithPaymentType(paymenttype.PaymentType(pt)) - } - } - - // Apply amount range filters - if amountMin, ok := filters["amount_min"].(string); ok && amountMin != "" { - if amt, err := strconv.ParseFloat(amountMin, 64); err == nil { - searchBuilder.WithAmount(fmt.Sprintf("%.2f", amt)) - } - } - - if amountMax, ok := filters["amount_max"].(string); ok && amountMax != "" { - if amt, err := strconv.ParseFloat(amountMax, 64); err == nil { - searchBuilder.WithAmount(fmt.Sprintf("%.2f", amt)) - } - } - - // Apply card last four filter - if cardLastFour, ok := filters["card_last_four"].(string); ok && cardLastFour != "" { - searchBuilder.WithCardNumberLastFour(cardLastFour) - } - - // Execute search - response, err := api.ExecuteGateway[reporting.PagedResult](ctx, searchBuilder) - if err != nil { - return nil, fmt.Errorf("transaction search failed: %w", err) - } - - // Format transaction list - transactions := formatTransactionList(response.Results) - - // Apply client-side status filtering if needed - if status, ok := filters["status"].(string); ok && status != "" { - transactions = filterByStatus(transactions, strings.ToUpper(status)) - } - - return map[string]interface{}{ - "success": true, - "data": map[string]interface{}{ - "transactions": transactions, - "pagination": Pagination{ - Page: page, - PageSize: pageSize, - TotalCount: len(transactions), - OriginalTotalCount: response.TotalRecordCount, - }, - }, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// GetTransactionDetails retrieves detailed information for a specific transaction -func (rs *ReportingService) GetTransactionDetails(transactionID string) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - ctx := context.Background() - - searchBuilder := builders.NewReportBuilder(builders.TransactionReportType) - searchBuilder.WithTransactionId(transactionID) - - response, err := api.ExecuteGateway[reporting.TransactionSummary](ctx, searchBuilder) - if err != nil { - return nil, fmt.Errorf("failed to retrieve transaction details: %w", err) - } - - details := formatTransactionDetails(response) - - return map[string]interface{}{ - "success": true, - "data": details, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// GetSettlementReport generates settlement report for a date range -func (rs *ReportingService) GetSettlementReport(params map[string]interface{}) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - ctx := context.Background() - - page := getIntValue(params, "page", 1) - pageSize := getIntValue(params, "page_size", 50) - if pageSize > 100 { - pageSize = 100 - } - - searchBuilder := builders.NewReportBuilder(builders.SettlementReportType) - searchBuilder.WithPaging(page, pageSize) - - // Apply date range - if startDate, ok := params["start_date"].(string); ok && startDate != "" { - if date, err := time.Parse("2006-01-02", startDate); err == nil { - searchBuilder.WithStartDate(date) - } - } - - if endDate, ok := params["end_date"].(string); ok && endDate != "" { - if date, err := time.Parse("2006-01-02", endDate); err == nil { - searchBuilder.WithEndDate(date) - } - } - - response, err := api.ExecuteGateway[reporting.PagedResult](ctx, searchBuilder) - if err != nil { - return nil, fmt.Errorf("settlement report generation failed: %w", err) - } - - settlements := formatSettlementList(response.Results) - summary := generateSettlementSummary(settlements) - - return map[string]interface{}{ - "success": true, - "data": map[string]interface{}{ - "settlements": settlements, - "summary": summary, - "pagination": Pagination{ - Page: page, - PageSize: pageSize, - TotalCount: response.TotalRecordCount, - }, - }, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// GetDisputeReport retrieves dispute reports with filtering and pagination -func (rs *ReportingService) GetDisputeReport(filters map[string]interface{}) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - ctx := context.Background() - - page := getIntValue(filters, "page", 1) - pageSize := getIntValue(filters, "page_size", 10) - if pageSize > 100 { - pageSize = 100 - } - - searchBuilder := builders.NewReportBuilder(builders.DisputeReportType) - searchBuilder.WithPaging(page, pageSize) - - // Apply date range filters - if startDate, ok := filters["start_date"].(string); ok && startDate != "" { - if date, err := time.Parse("2006-01-02", startDate); err == nil { - searchBuilder.WithStartDate(date) - } - } - - if endDate, ok := filters["end_date"].(string); ok && endDate != "" { - if date, err := time.Parse("2006-01-02", endDate); err == nil { - searchBuilder.WithEndDate(date) - } - } - - // Apply dispute stage filter - if stage, ok := filters["stage"].(string); ok && stage != "" { - searchBuilder.WithDisputeStage(stage) - } - - // Apply dispute status filter - if status, ok := filters["status"].(string); ok && status != "" { - searchBuilder.WithDisputeStatus(status) - } - - response, err := api.ExecuteGateway[reporting.PagedResult](ctx, searchBuilder) - if err != nil { - return nil, fmt.Errorf("dispute report generation failed: %w", err) - } - - disputes := formatDisputeList(response.Results) - - return map[string]interface{}{ - "success": true, - "data": map[string]interface{}{ - "disputes": disputes, - "pagination": Pagination{ - Page: page, - PageSize: pageSize, - TotalCount: response.TotalRecordCount, - }, - }, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// GetDisputeDetails retrieves detailed information for a specific dispute -func (rs *ReportingService) GetDisputeDetails(disputeID string) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - ctx := context.Background() - - searchBuilder := builders.NewReportBuilder(builders.DisputeReportType) - searchBuilder.WithDisputeId(disputeID) - - response, err := api.ExecuteGateway[reporting.DisputeSummary](ctx, searchBuilder) - if err != nil { - return nil, fmt.Errorf("failed to retrieve dispute details: %w", err) - } - - details := formatDisputeDetails(response) - - return map[string]interface{}{ - "success": true, - "data": details, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// GetDepositReport retrieves deposit reports with filtering and pagination -func (rs *ReportingService) GetDepositReport(filters map[string]interface{}) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - ctx := context.Background() - - page := getIntValue(filters, "page", 1) - pageSize := getIntValue(filters, "page_size", 10) - if pageSize > 100 { - pageSize = 100 - } - - searchBuilder := builders.NewReportBuilder(builders.DepositReportType) - searchBuilder.WithPaging(page, pageSize) - - // Apply date range filters - if startDate, ok := filters["start_date"].(string); ok && startDate != "" { - if date, err := time.Parse("2006-01-02", startDate); err == nil { - searchBuilder.WithStartDate(date) - } - } - - if endDate, ok := filters["end_date"].(string); ok && endDate != "" { - if date, err := time.Parse("2006-01-02", endDate); err == nil { - searchBuilder.WithEndDate(date) - } - } - - // Apply deposit ID filter - if depositID, ok := filters["deposit_id"].(string); ok && depositID != "" { - searchBuilder.WithDepositReference(depositID) - } - - // Apply status filter - if status, ok := filters["status"].(string); ok && status != "" { - searchBuilder.WithDepositStatus(status) - } - - response, err := api.ExecuteGateway[reporting.PagedResult](ctx, searchBuilder) - if err != nil { - return nil, fmt.Errorf("deposit report generation failed: %w", err) - } - - deposits := formatDepositList(response.Results) - - return map[string]interface{}{ - "success": true, - "data": map[string]interface{}{ - "deposits": deposits, - "pagination": Pagination{ - Page: page, - PageSize: pageSize, - TotalCount: response.TotalRecordCount, - }, - }, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// GetDepositDetails retrieves detailed information for a specific deposit -func (rs *ReportingService) GetDepositDetails(depositID string) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - ctx := context.Background() - - searchBuilder := builders.NewReportBuilder(builders.DepositReportType) - searchBuilder.WithDepositReference(depositID) - - response, err := api.ExecuteGateway[reporting.DepositSummary](ctx, searchBuilder) - if err != nil { - return nil, fmt.Errorf("failed to retrieve deposit details: %w", err) - } - - details := formatDepositDetails(response) - - return map[string]interface{}{ - "success": true, - "data": details, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// GetBatchReport retrieves batch report with detailed transaction information -func (rs *ReportingService) GetBatchReport(filters map[string]interface{}) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - ctx := context.Background() - - searchBuilder := builders.NewReportBuilder(builders.BatchReportType) - - // Apply date range filters - if startDate, ok := filters["start_date"].(string); ok && startDate != "" { - if date, err := time.Parse("2006-01-02", startDate); err == nil { - searchBuilder.WithStartDate(date) - } - } - - if endDate, ok := filters["end_date"].(string); ok && endDate != "" { - if date, err := time.Parse("2006-01-02", endDate); err == nil { - searchBuilder.WithEndDate(date) - } - } - - response, err := api.ExecuteGateway[reporting.PagedResult](ctx, searchBuilder) - if err != nil { - return nil, fmt.Errorf("batch report generation failed: %w", err) - } - - batches := formatBatchList(response.Results) - summary := generateBatchSummary(batches) - - return map[string]interface{}{ - "success": true, - "data": map[string]interface{}{ - "batches": batches, - "summary": summary, - }, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// GetDeclinedTransactionsReport retrieves declined transactions report -func (rs *ReportingService) GetDeclinedTransactionsReport(filters map[string]interface{}) (map[string]interface{}, error) { - // Use transaction search with declined status filter - filters["status"] = "DECLINED" - result, err := rs.SearchTransactions(filters) - if err != nil { - return nil, fmt.Errorf("declined transactions report generation failed: %w", err) - } - - // Add decline analysis - if result["success"] == true { - data := result["data"].(map[string]interface{}) - transactions := data["transactions"].([]TransactionInfo) - data["decline_analysis"] = analyzeDeclines(transactions) - } - - return result, nil -} - -// GetDateRangeReport generates comprehensive date range report across all transaction types -func (rs *ReportingService) GetDateRangeReport(params map[string]interface{}) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - startDate := getStringValue(params, "start_date", time.Now().AddDate(0, 0, -30).Format("2006-01-02")) - endDate := getStringValue(params, "end_date", time.Now().Format("2006-01-02")) - - report := map[string]interface{}{ - "success": true, - "data": map[string]interface{}{ - "period": map[string]string{ - "start_date": startDate, - "end_date": endDate, - }, - "transactions": map[string]interface{}{}, - "settlements": map[string]interface{}{}, - "disputes": map[string]interface{}{}, - "deposits": map[string]interface{}{}, - "summary": map[string]interface{}{}, - }, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - } - - data := report["data"].(map[string]interface{}) - - // Get transactions for the period - transactionResult, err := rs.SearchTransactions(map[string]interface{}{ - "start_date": startDate, - "end_date": endDate, - "page_size": getIntValue(params, "transaction_limit", 100), - }) - if err == nil && transactionResult["success"] == true { - data["transactions"] = transactionResult["data"] - } - - // Get settlements for the period - settlementResult, err := rs.GetSettlementReport(map[string]interface{}{ - "start_date": startDate, - "end_date": endDate, - "page_size": getIntValue(params, "settlement_limit", 50), - }) - if err == nil && settlementResult["success"] == true { - data["settlements"] = settlementResult["data"] - } - - // Get disputes for the period - disputeResult, err := rs.GetDisputeReport(map[string]interface{}{ - "start_date": startDate, - "end_date": endDate, - "page_size": getIntValue(params, "dispute_limit", 25), - }) - if err == nil { - data["disputes"] = disputeResult["data"] - } else { - data["disputes"] = map[string]string{"error": fmt.Sprintf("Disputes not available: %v", err)} - } - - // Get deposits for the period - depositResult, err := rs.GetDepositReport(map[string]interface{}{ - "start_date": startDate, - "end_date": endDate, - "page_size": getIntValue(params, "deposit_limit", 25), - }) - if err == nil { - data["deposits"] = depositResult["data"] - } else { - data["deposits"] = map[string]string{"error": fmt.Sprintf("Deposits not available: %v", err)} - } - - // Generate comprehensive summary - data["summary"] = generateComprehensiveSummary(data) - - return report, nil -} - -// ExportTransactions exports transaction data in specified format -func (rs *ReportingService) ExportTransactions(filters map[string]interface{}, format string) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - // Get all transactions (increase limit for export) - filters["page_size"] = 1000 - result, err := rs.SearchTransactions(filters) - if err != nil { - return nil, fmt.Errorf("export failed: %w", err) - } - - data := result["data"].(map[string]interface{}) - transactions := data["transactions"].([]TransactionInfo) - - switch format { - case "csv": - return exportToCSV(transactions) - case "xml": - return exportToXML(transactions) - default: // json - return map[string]interface{}{ - "success": true, - "data": transactions, - "format": "json", - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil - } -} - -// GetSummaryStats generates summary statistics -func (rs *ReportingService) GetSummaryStats(params map[string]interface{}) (map[string]interface{}, error) { - if !rs.isConfigured { - return nil, fmt.Errorf("SDK is not properly configured") - } - - startDate := getStringValue(params, "start_date", time.Now().AddDate(0, 0, -30).Format("2006-01-02")) - endDate := getStringValue(params, "end_date", time.Now().Format("2006-01-02")) - - // Get transaction summary - result, err := rs.SearchTransactions(map[string]interface{}{ - "start_date": startDate, - "end_date": endDate, - "page_size": 1000, - }) - if err != nil { - return map[string]interface{}{ - "success": false, - "error": fmt.Sprintf("Failed to generate summary statistics: %v", err), - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, err - } - - data := result["data"].(map[string]interface{}) - transactions := data["transactions"].([]TransactionInfo) - stats := calculateSummaryStats(transactions) - - return map[string]interface{}{ - "success": true, - "data": stats, - "period": map[string]string{ - "start_date": startDate, - "end_date": endDate, - }, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// Helper functions - -func getIntValue(m map[string]interface{}, key string, defaultValue int) int { - if val, ok := m[key]; ok { - switch v := val.(type) { - case int: - return v - case float64: - return int(v) - case string: - if i, err := strconv.Atoi(v); err == nil { - return i - } - } - } - return defaultValue -} - -func getStringValue(m map[string]interface{}, key string, defaultValue string) string { - if val, ok := m[key]; ok { - if str, ok := val.(string); ok { - return str - } - } - return defaultValue -} - -func mapPaymentType(pt string) string { - mapping := map[string]string{ - "sale": string(paymenttype.SALE), - "refund": string(paymenttype.REFUND), - "authorize": string(paymenttype.AUTH), - "capture": string(paymenttype.CAPTURE), - } - return mapping[strings.ToLower(pt)] -} - -func formatTransactionList(results interface{}) []TransactionInfo { - // Note: Actual implementation depends on SDK response structure - // This is a placeholder that should be adapted based on actual SDK types - transactions := []TransactionInfo{} - - // TODO: Parse actual SDK response structure - // For now, return empty list - this should be implemented based on actual SDK - - return transactions -} - -func formatTransactionDetails(txn interface{}) TransactionDetails { - // TODO: Parse actual SDK transaction detail structure - return TransactionDetails{} -} - -func formatSettlementList(results interface{}) []SettlementInfo { - // TODO: Parse actual SDK settlement structure - return []SettlementInfo{} -} - -func formatDisputeList(results interface{}) []DisputeInfo { - // TODO: Parse actual SDK dispute structure - return []DisputeInfo{} -} - -func formatDepositList(results interface{}) []DepositInfo { - // TODO: Parse actual SDK deposit structure - return []DepositInfo{} -} - -func formatBatchList(results interface{}) []BatchInfo { - // TODO: Parse actual SDK batch structure - return []BatchInfo{} -} - -func formatDisputeDetails(dispute interface{}) map[string]interface{} { - // TODO: Parse actual SDK dispute detail structure - return map[string]interface{}{} -} - -func formatDepositDetails(deposit interface{}) map[string]interface{} { - // TODO: Parse actual SDK deposit detail structure - return map[string]interface{}{} -} - -func filterByStatus(transactions []TransactionInfo, status string) []TransactionInfo { - filtered := []TransactionInfo{} - for _, txn := range transactions { - if strings.ToUpper(txn.Status) == status { - filtered = append(filtered, txn) - } - } - return filtered -} - -func generateSettlementSummary(settlements []SettlementInfo) map[string]interface{} { - var totalAmount float64 - var totalTransactions int - - for _, s := range settlements { - totalAmount += s.TotalAmount - totalTransactions += s.TransactionCount - } - - avgAmount := 0.0 - if len(settlements) > 0 { - avgAmount = totalAmount / float64(len(settlements)) - } - - return map[string]interface{}{ - "total_settlements": len(settlements), - "total_amount": totalAmount, - "total_transactions": totalTransactions, - "average_settlement_amount": avgAmount, - } -} - -func generateBatchSummary(batches []BatchInfo) map[string]interface{} { - var totalAmount float64 - var totalTransactions int - statusCounts := make(map[string]int) - - for _, b := range batches { - totalAmount += b.TotalAmount - totalTransactions += b.TransactionCount - statusCounts[b.BatchStatus]++ - } - - avgAmount := 0.0 - if len(batches) > 0 { - avgAmount = totalAmount / float64(len(batches)) - } - - return map[string]interface{}{ - "total_batches": len(batches), - "total_amount": totalAmount, - "total_transactions": totalTransactions, - "average_batch_amount": avgAmount, - "status_breakdown": statusCounts, - } -} - -func calculateSummaryStats(transactions []TransactionInfo) map[string]interface{} { - var totalAmount float64 - statusCounts := make(map[string]int) - paymentTypeCounts := make(map[string]int) - - for _, txn := range transactions { - totalAmount += txn.Amount - statusCounts[txn.Status]++ - paymentTypeCounts[txn.PaymentMethod]++ - } - - avgAmount := 0.0 - if len(transactions) > 0 { - avgAmount = totalAmount / float64(len(transactions)) - } - - return map[string]interface{}{ - "total_transactions": len(transactions), - "total_amount": totalAmount, - "average_amount": avgAmount, - "status_breakdown": statusCounts, - "payment_type_breakdown": paymentTypeCounts, - } -} - -func analyzeDeclines(transactions []TransactionInfo) map[string]interface{} { - var totalAmount float64 - declineReasons := make(map[string]int) - cardTypes := make(map[string]int) - hourlyBreakdown := make(map[string]int) - - for _, txn := range transactions { - totalAmount += txn.Amount - - // Card type breakdown - cardTypes[txn.PaymentMethod]++ - - // Parse timestamp for hourly breakdown - if t, err := time.Parse("2006-01-02 15:04:05", txn.Timestamp); err == nil { - hour := t.Format("15") - hourlyBreakdown[hour]++ - } - } - - avgAmount := 0.0 - if len(transactions) > 0 { - avgAmount = totalAmount / float64(len(transactions)) - } - - return map[string]interface{}{ - "total_declined_transactions": len(transactions), - "total_declined_amount": totalAmount, - "average_declined_amount": avgAmount, - "decline_reasons": declineReasons, - "card_type_breakdown": cardTypes, - "hourly_breakdown": hourlyBreakdown, - } -} - -func generateComprehensiveSummary(reportData map[string]interface{}) map[string]interface{} { - summary := map[string]interface{}{ - "overview": map[string]interface{}{}, - "financial_summary": map[string]interface{}{}, - "operational_metrics": map[string]interface{}{}, - } - - // Transaction overview - if txnData, ok := reportData["transactions"].(map[string]interface{}); ok { - if txns, ok := txnData["transactions"].([]TransactionInfo); ok && len(txns) > 0 { - var totalAmount float64 - for _, txn := range txns { - totalAmount += txn.Amount - } - - overview := summary["overview"].(map[string]interface{}) - overview["transactions"] = map[string]interface{}{ - "count": len(txns), - "total_amount": totalAmount, - "average_amount": totalAmount / float64(len(txns)), - } - } - } - - return summary -} - -func exportToCSV(transactions []TransactionInfo) (map[string]interface{}, error) { - var builder strings.Builder - writer := csv.NewWriter(&builder) - - // Write header - header := []string{"Transaction ID", "Timestamp", "Amount", "Currency", "Status", "Payment Method", "Card Last Four", "Auth Code", "Reference Number"} - writer.Write(header) - - // Write data - for _, txn := range transactions { - record := []string{ - txn.TransactionID, - txn.Timestamp, - fmt.Sprintf("%.2f", txn.Amount), - txn.Currency, - txn.Status, - txn.PaymentMethod, - txn.CardLastFour, - txn.AuthCode, - txn.ReferenceNumber, - } - writer.Write(record) - } - - writer.Flush() - if err := writer.Error(); err != nil { - return nil, err - } - - filename := fmt.Sprintf("transactions_%s.csv", time.Now().Format("2006-01-02_15-04-05")) - - return map[string]interface{}{ - "success": true, - "data": builder.String(), - "format": "csv", - "filename": filename, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -func exportToXML(transactions []TransactionInfo) (map[string]interface{}, error) { - type TransactionList struct { - XMLName xml.Name `xml:"transactions"` - Transactions []TransactionInfo `xml:"transaction"` - } - - txnList := TransactionList{Transactions: transactions} - xmlData, err := xml.MarshalIndent(txnList, "", " ") - if err != nil { - return nil, err - } - - filename := fmt.Sprintf("transactions_%s.xml", time.Now().Format("2006-01-02_15-04-05")) - - return map[string]interface{}{ - "success": true, - "data": string(xmlData), - "format": "xml", - "filename": filename, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - }, nil -} - -// GetSDKConfigStatus returns current SDK configuration status -func GetSDKConfigStatus() map[string]interface{} { - appID := os.Getenv("GP_API_APP_ID") - appKey := os.Getenv("GP_API_APP_KEY") - - hasAppID := appID != "" - hasAppKey := appKey != "" - isConfigured := hasAppID && hasAppKey - - env := "Not configured" - if isConfigured { - env = "TEST" - } - - return map[string]interface{}{ - "configured": isConfigured, - "has_app_id": hasAppID, - "has_app_key": hasAppKey, - "environment": env, - "timestamp": time.Now().Format("2006-01-02 15:04:05"), - } -} - -// ValidateEnvironmentConfig validates environment configuration -func ValidateEnvironmentConfig() map[string]interface{} { - results := map[string]interface{}{ - "valid": true, - "errors": []string{}, - "warnings": []string{}, - } - - errors := []string{} - warnings := []string{} - - // Check required variables - required := []string{"GP_API_APP_ID", "GP_API_APP_KEY"} - for _, varName := range required { - if os.Getenv(varName) == "" { - errors = append(errors, fmt.Sprintf("Missing required environment variable: %s", varName)) - results["valid"] = false - } - } - - // Check legacy variables and warn if present - legacy := []string{"PUBLIC_API_KEY", "SECRET_API_KEY"} - for _, varName := range legacy { - if os.Getenv(varName) != "" { - warnings = append(warnings, fmt.Sprintf("Legacy variable %s found. GP-API uses GP_API_APP_ID and GP_API_APP_KEY.", varName)) - } - } - - results["errors"] = errors - results["warnings"] = warnings - - return results -} \ No newline at end of file diff --git a/go/reports.go b/go/reports.go deleted file mode 100644 index 0dec167..0000000 --- a/go/reports.go +++ /dev/null @@ -1,1077 +0,0 @@ -// Package main implements HTTP handler functions for Global Payments Reporting API. -// This file provides RESTful API endpoints for accessing Global Payments -// reporting functionality including transaction search, details, settlement -// reports, and data export capabilities. -package main - -import ( - "encoding/json" - "fmt" - "log" - "net/http" - "strconv" - "strings" - "time" - - "github.com/gorilla/mux" -) - -// APIResponse represents a standardized API response -type APIResponse struct { - Success bool `json:"success"` - Data interface{} `json:"data,omitempty"` - Error *APIError `json:"error,omitempty"` - Timestamp string `json:"timestamp"` -} - -// APIError represents error details in the response -type APIError struct { - Code string `json:"code"` - Message string `json:"message"` - Timestamp string `json:"timestamp"` -} - -// APIEndpointInfo represents documentation for a single endpoint -type APIEndpointInfo struct { - URL string `json:"url"` - Method string `json:"method"` - Description string `json:"description"` - Parameters map[string]string `json:"parameters"` -} - -var reportingService *ReportingService - -// InitializeReportingAPI initializes the reporting service and sets up routes -func InitializeReportingAPI(router *mux.Router) error { - var err error - reportingService, err = NewReportingService() - if err != nil { - return fmt.Errorf("failed to initialize reporting service: %w", err) - } - - // Set up routes - router.HandleFunc("/reports", handleReports).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/search", handleSearch).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/detail", handleDetail).Methods("GET", "OPTIONS") - router.HandleFunc("/reports/settlement", handleSettlement).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/export", handleExport).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/summary", handleSummary).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/disputes", handleDisputes).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/dispute/{id}", handleDisputeDetail).Methods("GET", "OPTIONS") - router.HandleFunc("/reports/deposits", handleDeposits).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/deposit/{id}", handleDepositDetail).Methods("GET", "OPTIONS") - router.HandleFunc("/reports/batches", handleBatches).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/declines", handleDeclines).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/date-range", handleDateRange).Methods("GET", "POST", "OPTIONS") - router.HandleFunc("/reports/config", handleReportsConfig).Methods("GET", "OPTIONS") - - return nil -} - -// setJSONHeaders sets standard JSON response headers with CORS support -func setJSONHeaders(w http.ResponseWriter) { - w.Header().Set("Content-Type", "application/json") - w.Header().Set("Access-Control-Allow-Origin", "*") - w.Header().Set("Access-Control-Allow-Methods", "GET, POST, OPTIONS") - w.Header().Set("Access-Control-Allow-Headers", "Content-Type, Authorization") -} - -// handlePreflight handles OPTIONS preflight requests -func handlePreflight(w http.ResponseWriter, r *http.Request) bool { - if r.Method == "OPTIONS" { - setJSONHeaders(w) - w.WriteHeader(http.StatusOK) - return true - } - return false -} - -// sendJSONResponse sends a JSON response with the specified status code -func sendJSONResponse(w http.ResponseWriter, data interface{}, statusCode int) { - setJSONHeaders(w) - w.WriteHeader(statusCode) - json.NewEncoder(w).Encode(data) -} - -// handleError sends an error response -func handleError(w http.ResponseWriter, message string, statusCode int, errorCode string) { - response := APIResponse{ - Success: false, - Error: &APIError{ - Code: errorCode, - Message: message, - Timestamp: time.Now().Format("2006-01-02 15:04:05"), - }, - Timestamp: time.Now().Format("2006-01-02 15:04:05"), - } - sendJSONResponse(w, response, statusCode) -} - -// getRequestParams extracts parameters from both GET and POST requests -func getRequestParams(r *http.Request) (map[string]interface{}, error) { - params := make(map[string]interface{}) - - // Get query parameters - for key, values := range r.URL.Query() { - if len(values) > 0 { - params[key] = values[0] - } - } - - // Get POST body parameters if applicable - if r.Method == "POST" { - contentType := r.Header.Get("Content-Type") - if strings.Contains(contentType, "application/json") { - var jsonParams map[string]interface{} - if err := json.NewDecoder(r.Body).Decode(&jsonParams); err == nil { - for key, value := range jsonParams { - params[key] = value - } - } - } else if err := r.ParseForm(); err == nil { - for key, values := range r.Form { - if len(values) > 0 { - params[key] = values[0] - } - } - } - } - - return params, nil -} - -// validateRequiredParams validates that required parameters are present -func validateRequiredParams(params map[string]interface{}, required []string) error { - for _, param := range required { - if val, ok := params[param]; !ok || val == "" { - return fmt.Errorf("missing required parameter: %s", param) - } - } - return nil -} - -// validateDateFormat validates date format -func validateDateFormat(dateStr string) error { - if dateStr == "" { - return nil - } - _, err := time.Parse("2006-01-02", dateStr) - if err != nil { - return fmt.Errorf("invalid date format. Use YYYY-MM-DD") - } - return nil -} - -// removeEmptyParams removes empty string values from params -func removeEmptyParams(params map[string]interface{}) map[string]interface{} { - cleaned := make(map[string]interface{}) - for key, value := range params { - if str, ok := value.(string); ok && str != "" { - cleaned[key] = value - } else if !ok { - cleaned[key] = value - } - } - return cleaned -} - -// handleReports handles the main /reports endpoint (API documentation) -func handleReports(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - // Check if action parameter is provided for backward compatibility - params, _ := getRequestParams(r) - if action, ok := params["action"].(string); ok && action != "" { - // Route based on action parameter (PHP-style compatibility) - handleActionBasedRouting(w, r, action, params) - return - } - - // Default: show API documentation - endpoints := map[string]APIEndpointInfo{ - "search": { - URL: "/reports/search", - Method: "GET/POST", - Description: "Search transactions with filters and pagination", - Parameters: map[string]string{ - "page": "Page number (default: 1)", - "page_size": "Results per page (default: 10, max: 100)", - "start_date": "Start date (YYYY-MM-DD)", - "end_date": "End date (YYYY-MM-DD)", - "transaction_id": "Specific transaction ID", - "payment_type": "Payment type (sale, refund, authorize, capture)", - "status": "Transaction status", - "amount_min": "Minimum amount", - "amount_max": "Maximum amount", - "card_last_four": "Last 4 digits of card", - }, - }, - "detail": { - URL: "/reports/detail?transaction_id={id}", - Method: "GET", - Description: "Get detailed transaction information", - Parameters: map[string]string{ - "transaction_id": "Transaction ID (required)", - }, - }, - "settlement": { - URL: "/reports/settlement", - Method: "GET/POST", - Description: "Get settlement report", - Parameters: map[string]string{ - "page": "Page number (default: 1)", - "page_size": "Results per page (default: 50, max: 100)", - "start_date": "Start date (YYYY-MM-DD)", - "end_date": "End date (YYYY-MM-DD)", - }, - }, - "export": { - URL: "/reports/export?format={json|csv|xml}", - Method: "GET/POST", - Description: "Export transaction data", - Parameters: map[string]string{ - "format": "Export format (json, csv, or xml)", - "...filters": "Same filters as search endpoint", - }, - }, - "summary": { - URL: "/reports/summary", - Method: "GET/POST", - Description: "Get summary statistics", - Parameters: map[string]string{ - "start_date": "Start date (YYYY-MM-DD)", - "end_date": "End date (YYYY-MM-DD)", - }, - }, - "disputes": { - URL: "/reports/disputes", - Method: "GET/POST", - Description: "Get dispute report", - Parameters: map[string]string{ - "page": "Page number (default: 1)", - "page_size": "Results per page (default: 10, max: 100)", - "start_date": "Start date (YYYY-MM-DD)", - "end_date": "End date (YYYY-MM-DD)", - "stage": "Dispute stage", - "status": "Dispute status", - }, - }, - "deposits": { - URL: "/reports/deposits", - Method: "GET/POST", - Description: "Get deposit report", - Parameters: map[string]string{ - "page": "Page number (default: 1)", - "page_size": "Results per page (default: 10, max: 100)", - "start_date": "Start date (YYYY-MM-DD)", - "end_date": "End date (YYYY-MM-DD)", - "deposit_id": "Specific deposit ID", - "status": "Deposit status", - }, - }, - "batches": { - URL: "/reports/batches", - Method: "GET/POST", - Description: "Get batch report", - Parameters: map[string]string{ - "start_date": "Start date (YYYY-MM-DD)", - "end_date": "End date (YYYY-MM-DD)", - }, - }, - "declines": { - URL: "/reports/declines", - Method: "GET/POST", - Description: "Get declined transactions report", - Parameters: map[string]string{ - "page": "Page number (default: 1)", - "page_size": "Results per page (default: 10, max: 100)", - "start_date": "Start date (YYYY-MM-DD)", - "end_date": "End date (YYYY-MM-DD)", - "payment_type": "Payment type", - "amount_min": "Minimum amount", - "amount_max": "Maximum amount", - "card_last_four": "Last 4 digits of card", - }, - }, - "date_range": { - URL: "/reports/date-range", - Method: "GET/POST", - Description: "Get comprehensive date range report", - Parameters: map[string]string{ - "start_date": "Start date (YYYY-MM-DD)", - "end_date": "End date (YYYY-MM-DD)", - "transaction_limit": "Max transactions to retrieve (default: 100, max: 1000)", - "settlement_limit": "Max settlements to retrieve (default: 50, max: 500)", - "dispute_limit": "Max disputes to retrieve (default: 25, max: 100)", - "deposit_limit": "Max deposits to retrieve (default: 25, max: 100)", - }, - }, - "config": { - URL: "/reports/config", - Method: "GET", - Description: "Get API configuration and status", - Parameters: map[string]string{}, - }, - } - - response := APIResponse{ - Success: true, - Data: map[string]interface{}{ - "name": "Global Payments Reporting API", - "version": "1.0.0", - "description": "RESTful API for Global Payments transaction reporting and analytics", - "endpoints": endpoints, - }, - Timestamp: time.Now().Format("2006-01-02 15:04:05"), - } - - sendJSONResponse(w, response, http.StatusOK) -} - -// handleActionBasedRouting routes requests based on action parameter (PHP compatibility) -func handleActionBasedRouting(w http.ResponseWriter, r *http.Request, action string, params map[string]interface{}) { - switch action { - case "search": - handleSearchWithParams(w, r, params) - case "detail": - handleDetailWithParams(w, r, params) - case "settlement": - handleSettlementWithParams(w, r, params) - case "export": - handleExportWithParams(w, r, params) - case "summary": - handleSummaryWithParams(w, r, params) - case "disputes": - handleDisputesWithParams(w, r, params) - case "dispute_detail": - handleDisputeDetailWithParams(w, r, params) - case "deposits": - handleDepositsWithParams(w, r, params) - case "deposit_detail": - handleDepositDetailWithParams(w, r, params) - case "batches": - handleBatchesWithParams(w, r, params) - case "declines": - handleDeclinesWithParams(w, r, params) - case "date_range": - handleDateRangeWithParams(w, r, params) - case "config": - handleReportsConfig(w, r) - default: - handleError(w, fmt.Sprintf("Invalid action: %s", action), http.StatusBadRequest, "INVALID_ACTION") - } -} - -// handleSearch handles transaction search requests -func handleSearch(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleSearchWithParams(w, r, params) -} - -func handleSearchWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - // Build filters - filters := make(map[string]interface{}) - - // Pagination - if page, ok := params["page"].(string); ok { - if p, err := strconv.Atoi(page); err == nil { - filters["page"] = p - } - } - if pageSize, ok := params["page_size"].(string); ok { - if ps, err := strconv.Atoi(pageSize); err == nil && ps <= 100 { - filters["page_size"] = ps - } - } - - // Date filters - if startDate, ok := params["start_date"].(string); ok { - if err := validateDateFormat(startDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - filters["start_date"] = startDate - } - - if endDate, ok := params["end_date"].(string); ok { - if err := validateDateFormat(endDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - filters["end_date"] = endDate - } - - // Other filters - filterKeys := []string{"transaction_id", "payment_type", "status", "amount_min", "amount_max", "card_last_four"} - for _, key := range filterKeys { - if val, ok := params[key]; ok { - filters[key] = val - } - } - - filters = removeEmptyParams(filters) - - result, err := reportingService.SearchTransactions(filters) - if err != nil { - handleError(w, fmt.Sprintf("Transaction search failed: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleDetail handles transaction detail requests -func handleDetail(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleDetailWithParams(w, r, params) -} - -func handleDetailWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - if err := validateRequiredParams(params, []string{"transaction_id"}); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - - transactionID := params["transaction_id"].(string) - result, err := reportingService.GetTransactionDetails(transactionID) - if err != nil { - handleError(w, fmt.Sprintf("Failed to retrieve transaction details: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleSettlement handles settlement report requests -func handleSettlement(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleSettlementWithParams(w, r, params) -} - -func handleSettlementWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - settlementParams := make(map[string]interface{}) - - // Pagination - if page, ok := params["page"].(string); ok { - if p, err := strconv.Atoi(page); err == nil { - settlementParams["page"] = p - } - } - if pageSize, ok := params["page_size"].(string); ok { - if ps, err := strconv.Atoi(pageSize); err == nil && ps <= 100 { - settlementParams["page_size"] = ps - } - } - - // Date filters - if startDate, ok := params["start_date"].(string); ok { - if err := validateDateFormat(startDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - settlementParams["start_date"] = startDate - } - - if endDate, ok := params["end_date"].(string); ok { - if err := validateDateFormat(endDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - settlementParams["end_date"] = endDate - } - - settlementParams = removeEmptyParams(settlementParams) - - result, err := reportingService.GetSettlementReport(settlementParams) - if err != nil { - handleError(w, fmt.Sprintf("Settlement report generation failed: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleExport handles transaction export requests -func handleExport(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleExportWithParams(w, r, params) -} - -func handleExportWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - format := "json" - if f, ok := params["format"].(string); ok { - format = strings.ToLower(f) - } - - if format != "json" && format != "csv" && format != "xml" { - handleError(w, "Invalid format. Supported formats: json, csv, xml", http.StatusBadRequest, "VALIDATION_ERROR") - return - } - - // Build export filters - exportFilters := make(map[string]interface{}) - filterKeys := []string{"start_date", "end_date", "transaction_id", "payment_type", "status", "amount_min", "amount_max", "card_last_four"} - - for _, key := range filterKeys { - if val, ok := params[key].(string); ok { - if key == "start_date" || key == "end_date" { - if err := validateDateFormat(val); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - } - exportFilters[key] = val - } - } - - exportFilters = removeEmptyParams(exportFilters) - - result, err := reportingService.ExportTransactions(exportFilters, format) - if err != nil { - handleError(w, fmt.Sprintf("Export failed: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - // Handle CSV/XML export with appropriate headers - if format == "csv" { - w.Header().Set("Content-Type", "text/csv") - filename := "transactions.csv" - if fn, ok := result["filename"].(string); ok { - filename = fn - } - w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", filename)) - if data, ok := result["data"].(string); ok { - w.Write([]byte(data)) - } - return - } else if format == "xml" { - w.Header().Set("Content-Type", "application/xml") - filename := "transactions.xml" - if fn, ok := result["filename"].(string); ok { - filename = fn - } - w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", filename)) - if data, ok := result["data"].(string); ok { - w.Write([]byte(data)) - } - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleSummary handles summary statistics requests -func handleSummary(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleSummaryWithParams(w, r, params) -} - -func handleSummaryWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - summaryParams := make(map[string]interface{}) - - if startDate, ok := params["start_date"].(string); ok { - if err := validateDateFormat(startDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - summaryParams["start_date"] = startDate - } - - if endDate, ok := params["end_date"].(string); ok { - if err := validateDateFormat(endDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - summaryParams["end_date"] = endDate - } - - summaryParams = removeEmptyParams(summaryParams) - - result, err := reportingService.GetSummaryStats(summaryParams) - if err != nil { - handleError(w, fmt.Sprintf("Summary generation failed: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleDisputes handles dispute report requests -func handleDisputes(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleDisputesWithParams(w, r, params) -} - -func handleDisputesWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - disputeFilters := make(map[string]interface{}) - - // Pagination - if page, ok := params["page"].(string); ok { - if p, err := strconv.Atoi(page); err == nil { - disputeFilters["page"] = p - } - } - if pageSize, ok := params["page_size"].(string); ok { - if ps, err := strconv.Atoi(pageSize); err == nil && ps <= 100 { - disputeFilters["page_size"] = ps - } - } - - // Date filters - if startDate, ok := params["start_date"].(string); ok { - if err := validateDateFormat(startDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - disputeFilters["start_date"] = startDate - } - - if endDate, ok := params["end_date"].(string); ok { - if err := validateDateFormat(endDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - disputeFilters["end_date"] = endDate - } - - // Dispute-specific filters - if stage, ok := params["stage"]; ok { - disputeFilters["stage"] = stage - } - if status, ok := params["status"]; ok { - disputeFilters["status"] = status - } - - disputeFilters = removeEmptyParams(disputeFilters) - - result, err := reportingService.GetDisputeReport(disputeFilters) - if err != nil { - handleError(w, fmt.Sprintf("Dispute report generation failed: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleDisputeDetail handles dispute detail requests -func handleDisputeDetail(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - vars := mux.Vars(r) - disputeID := vars["id"] - - if disputeID == "" { - params, _ := getRequestParams(r) - handleDisputeDetailWithParams(w, r, params) - return - } - - result, err := reportingService.GetDisputeDetails(disputeID) - if err != nil { - handleError(w, fmt.Sprintf("Failed to retrieve dispute details: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -func handleDisputeDetailWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - if err := validateRequiredParams(params, []string{"dispute_id"}); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - - disputeID := params["dispute_id"].(string) - result, err := reportingService.GetDisputeDetails(disputeID) - if err != nil { - handleError(w, fmt.Sprintf("Failed to retrieve dispute details: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleDeposits handles deposit report requests -func handleDeposits(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleDepositsWithParams(w, r, params) -} - -func handleDepositsWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - depositFilters := make(map[string]interface{}) - - // Pagination - if page, ok := params["page"].(string); ok { - if p, err := strconv.Atoi(page); err == nil { - depositFilters["page"] = p - } - } - if pageSize, ok := params["page_size"].(string); ok { - if ps, err := strconv.Atoi(pageSize); err == nil && ps <= 100 { - depositFilters["page_size"] = ps - } - } - - // Date filters - if startDate, ok := params["start_date"].(string); ok { - if err := validateDateFormat(startDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - depositFilters["start_date"] = startDate - } - - if endDate, ok := params["end_date"].(string); ok { - if err := validateDateFormat(endDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - depositFilters["end_date"] = endDate - } - - // Deposit-specific filters - if depositID, ok := params["deposit_id"]; ok { - depositFilters["deposit_id"] = depositID - } - if status, ok := params["status"]; ok { - depositFilters["status"] = status - } - - depositFilters = removeEmptyParams(depositFilters) - - result, err := reportingService.GetDepositReport(depositFilters) - if err != nil { - handleError(w, fmt.Sprintf("Deposit report generation failed: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleDepositDetail handles deposit detail requests -func handleDepositDetail(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - vars := mux.Vars(r) - depositID := vars["id"] - - if depositID == "" { - params, _ := getRequestParams(r) - handleDepositDetailWithParams(w, r, params) - return - } - - result, err := reportingService.GetDepositDetails(depositID) - if err != nil { - handleError(w, fmt.Sprintf("Failed to retrieve deposit details: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -func handleDepositDetailWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - if err := validateRequiredParams(params, []string{"deposit_id"}); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - - depositID := params["deposit_id"].(string) - result, err := reportingService.GetDepositDetails(depositID) - if err != nil { - handleError(w, fmt.Sprintf("Failed to retrieve deposit details: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleBatches handles batch report requests -func handleBatches(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleBatchesWithParams(w, r, params) -} - -func handleBatchesWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - batchFilters := make(map[string]interface{}) - - if startDate, ok := params["start_date"].(string); ok { - if err := validateDateFormat(startDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - batchFilters["start_date"] = startDate - } - - if endDate, ok := params["end_date"].(string); ok { - if err := validateDateFormat(endDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - batchFilters["end_date"] = endDate - } - - batchFilters = removeEmptyParams(batchFilters) - - result, err := reportingService.GetBatchReport(batchFilters) - if err != nil { - handleError(w, fmt.Sprintf("Batch report generation failed: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleDeclines handles declined transactions report requests -func handleDeclines(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleDeclinesWithParams(w, r, params) -} - -func handleDeclinesWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - declineFilters := make(map[string]interface{}) - - // Pagination - if page, ok := params["page"].(string); ok { - if p, err := strconv.Atoi(page); err == nil { - declineFilters["page"] = p - } - } - if pageSize, ok := params["page_size"].(string); ok { - if ps, err := strconv.Atoi(pageSize); err == nil && ps <= 100 { - declineFilters["page_size"] = ps - } - } - - // Date filters - if startDate, ok := params["start_date"].(string); ok { - if err := validateDateFormat(startDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - declineFilters["start_date"] = startDate - } - - if endDate, ok := params["end_date"].(string); ok { - if err := validateDateFormat(endDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - declineFilters["end_date"] = endDate - } - - // Other filters - filterKeys := []string{"payment_type", "amount_min", "amount_max", "card_last_four"} - for _, key := range filterKeys { - if val, ok := params[key]; ok { - declineFilters[key] = val - } - } - - declineFilters = removeEmptyParams(declineFilters) - - result, err := reportingService.GetDeclinedTransactionsReport(declineFilters) - if err != nil { - handleError(w, fmt.Sprintf("Declined transactions report generation failed: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleDateRange handles comprehensive date range report requests -func handleDateRange(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - params, err := getRequestParams(r) - if err != nil { - handleError(w, "Failed to parse request parameters", http.StatusBadRequest, "PARSE_ERROR") - return - } - - handleDateRangeWithParams(w, r, params) -} - -func handleDateRangeWithParams(w http.ResponseWriter, r *http.Request, params map[string]interface{}) { - dateRangeParams := make(map[string]interface{}) - - if startDate, ok := params["start_date"].(string); ok { - if err := validateDateFormat(startDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - dateRangeParams["start_date"] = startDate - } - - if endDate, ok := params["end_date"].(string); ok { - if err := validateDateFormat(endDate); err != nil { - handleError(w, err.Error(), http.StatusBadRequest, "VALIDATION_ERROR") - return - } - dateRangeParams["end_date"] = endDate - } - - // Limit parameters - limitKeys := []string{"transaction_limit", "settlement_limit", "dispute_limit", "deposit_limit"} - maxLimits := map[string]int{"transaction_limit": 1000, "settlement_limit": 500, "dispute_limit": 100, "deposit_limit": 100} - - for _, key := range limitKeys { - if val, ok := params[key].(string); ok { - if limit, err := strconv.Atoi(val); err == nil { - if limit > maxLimits[key] { - limit = maxLimits[key] - } - dateRangeParams[key] = limit - } - } - } - - dateRangeParams = removeEmptyParams(dateRangeParams) - - result, err := reportingService.GetDateRangeReport(dateRangeParams) - if err != nil { - handleError(w, fmt.Sprintf("Date range report generation failed: %v", err), http.StatusInternalServerError, "API_ERROR") - return - } - - sendJSONResponse(w, result, http.StatusOK) -} - -// handleReportsConfig handles configuration status requests -func handleReportsConfig(w http.ResponseWriter, r *http.Request) { - if handlePreflight(w, r) { - return - } - - configStatus := GetSDKConfigStatus() - envValidation := ValidateEnvironmentConfig() - - response := APIResponse{ - Success: true, - Data: map[string]interface{}{ - "sdk_status": configStatus, - "environment_validation": envValidation, - "api_endpoints": map[string]string{ - "search": "/reports/search", - "detail": "/reports/detail?transaction_id={id}", - "settlement": "/reports/settlement", - "disputes": "/reports/disputes", - "dispute_detail": "/reports/dispute/{id}", - "deposits": "/reports/deposits", - "deposit_detail": "/reports/deposit/{id}", - "batches": "/reports/batches", - "declines": "/reports/declines", - "date_range": "/reports/date-range", - "export": "/reports/export?format={json|csv|xml}", - "summary": "/reports/summary", - "config": "/reports/config", - }, - }, - Timestamp: time.Now().Format("2006-01-02 15:04:05"), - } - - sendJSONResponse(w, response, http.StatusOK) -} - -// StartReportingServer starts a standalone reporting server -func StartReportingServer(port string) error { - router := mux.NewRouter() - - if err := InitializeReportingAPI(router); err != nil { - return fmt.Errorf("failed to initialize reporting API: %w", err) - } - - log.Printf("Reporting API server starting on http://localhost:%s", port) - log.Printf("API documentation available at http://localhost:%s/reports", port) - - return http.ListenAndServe("0.0.0.0:"+port, router) -} \ No newline at end of file diff --git a/go/run.sh b/go/run.sh deleted file mode 100755 index 555ddfc..0000000 --- a/go/run.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/bash - -# Exit on error -set -e - -# Install dependencies -go mod download - -# Start the server -go run main.go diff --git a/go/static/documentation.html b/go/static/documentation.html deleted file mode 100644 index 35a9a7f..0000000 --- a/go/static/documentation.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - Transaction Reporting API Documentation - Go - - - - - - - - -
-
-
- - -
-
-
- -
- -

Transaction Reporting API

-

Query and export transaction data from Global Payments

- -
- ← Back to Dashboard -
- -
-
-

Setup

-

Add the following to your .env file:

- 
GP_API_APP_ID=your_app_id_here
-GP_API_APP_KEY=your_app_key_here
-

Download dependencies: go mod download

-

Start server: go run main_reporting.go

-
- -
-

Endpoints

-

Base URL: http://localhost:8080/api/reports?action=

- -

Search Transactions

-
- 
curl "http://localhost:8080/api/reports?action=search&start_date=2025-09-01&page_size=20"
-
- -

Parameters:

-
    -
  • page - Page number (default: 1)
    • -
  • page_size - Items per page (max: 100)
    • -
  • start_date - YYYY-MM-DD
    • -
  • end_date - YYYY-MM-DD
    • -
  • status - CAPTURED, DECLINED, PENDING, REVERSED
    • -
  • transaction_id - Specific transaction
    • -
  • amount_min / amount_max - Amount range
    • -
  • card_last_four - Last 4 card digits
    • -
- -

Transaction Details

-
- 
curl "http://localhost:8080/api/reports?action=detail&transaction_id=TRN_xxx"
-
- -

Export Data

-
-

CSV:

- 
curl "http://localhost:8080/api/reports?action=export&format=csv&start_date=2025-09-01" -o file.csv
- -

JSON:

- 
curl "http://localhost:8080/api/reports?action=export&format=json&start_date=2025-09-01" -o file.json
-
-
- Note: Exports up to 1000 records. Use filters to narrow results. -
- -

Summary Stats

-
- 
curl "http://localhost:8080/api/reports?action=summary&start_date=2025-09-01&end_date=2025-09-30"
-
-

Returns totals, averages, and breakdowns by status/payment type.

- -

Declined Transactions

-
- 
curl "http://localhost:8080/api/reports?action=declines&start_date=2025-09-01&page_size=20"
-
-

Returns declined transactions with analysis (reasons, card types, trends).

- -

Settlement Report

-
- 
curl "http://localhost:8080/api/reports?action=settlement&start_date=2025-09-01"
-
- -

Disputes

-
- 
curl "http://localhost:8080/api/reports?action=disputes&status=PENDING"
-
- -

Deposits

-
- 
curl "http://localhost:8080/api/reports?action=deposits&start_date=2025-09-01"
-
- -

Batches

-
- 
curl "http://localhost:8080/api/reports?action=batches&start_date=2025-09-01"
-
-
- -
-

Response Format

-

All responses follow this structure:

- -

Success Response:

- 
{
-  "success": true,
-  "data": { ... },
-  "timestamp": "2025-10-06 12:00:00"
-}
- -

Error Response:

- 
{
-  "success": false,
-  "error": {
-    "code": "VALIDATION_ERROR",
-    "message": "Invalid date format",
-    "timestamp": "2025-10-06 12:00:00"
-  }
-}
-
- -
-

Common Filters

-

All search endpoints support:

-
    -
  • Date ranges: start_date and end_date
    • -
  • Pagination: page and page_size
    • -
  • Status filtering where applicable
    • -
-
- -
-

Important Notes

-
-
    -
  • Dates must be YYYY-MM-DD format
    • -
  • Page size max is 100 (search/disputes/deposits)
    • -
  • Export limit is 1000 records
    • -
  • All timestamps are UTC
    • -
  • Transaction IDs start with TRN_
    • -
-
-
-
-
- - - - - - - diff --git a/go/static/index.html b/go/static/index.html deleted file mode 100644 index d4d0a70..0000000 --- a/go/static/index.html +++ /dev/null @@ -1,634 +0,0 @@ - - - - - - Global Payments - Developer Example - - - - - - - -
-
-
- - -
-
-
- -
- -

SDK Reporting Service

-

Comprehensive reporting service for Global Payments transactions, providing search, filtering, and export capabilities.

- - -
-
- - - -
- - -
-
-
-

Credit Card Payment Form

-

- Secure payment processing using Global Payments tokenization with client-side form validation. -

-
- -
-
- - -
- -
- - -
- -
- -
-
- - -
-
-
- - -
-
-
-

Reporting Operations

-

- Access comprehensive transaction reporting, search, and export functionality. -

-
- -
- Documentation: For detailed information on performing reporting operations, please refer to the REPORTING_README.md document. -
- -
-

Available Reporting Features:

-
    -
  • Transaction Search: Search and filter transactions by various criteria
    • -
  • Transaction Details: View detailed information for specific transactions
    • -
  • Summary Reports: Generate summaries with totals and statistics
    • -
  • Declined Transactions: Filter and analyze declined payments
    • -
  • Export Functionality: Export reports in CSV, JSON, and XML formats
    • -
-
- -
- - View Full Documentation - -
-
-
- - -
-
-
-

Transaction Report

-

- View recent transaction details in a simple table format. -

-
- - - - - -
- - - - -
- - -
-
- -
Loading transaction data...
-
-
- - - - - - -
-
-
-
- - - - - - - - - - \ No newline at end of file diff --git a/java/.codesandbox/tasks.json b/java/.codesandbox/tasks.json new file mode 100644 index 0000000..a114eb2 --- /dev/null +++ b/java/.codesandbox/tasks.json @@ -0,0 +1,29 @@ +{ + // These tasks will run in order when initializing your CodeSandbox project. + "setupTasks": [ + { + "name": "Install Dependencies", + "command": "mvn clean package" + }, + { + "name": "Create .env", + "command": "cp .env.sample .env" + } + ], + + // These tasks can be run from CodeSandbox. Running one will open a log in the app. + "tasks": { + "start": { + "name": "start", + "command": "mvn cargo:run", + "runAtStart": true, + "preview": { + "port": 8000 + } + }, + "install": { + "name": "install dependencies", + "command": "mvn clean package" + } + } +} diff --git a/java/.codesandbox/template.json b/java/.codesandbox/template.json new file mode 100644 index 0000000..e1d762f --- /dev/null +++ b/java/.codesandbox/template.json @@ -0,0 +1,7 @@ +{ + "title": "Global Payments Java", + "description": "The easiest way to get started from Docker in CodeSandbox", + "iconUrl": "https://globalpayments-samples.github.io/assets/img/g-symbol-dev-brand.png", + "tags": ["global-payments", "sample", "java"], + "published": false +} \ No newline at end of file diff --git a/java/.devcontainer/Dockerfile b/java/.devcontainer/Dockerfile new file mode 100644 index 0000000..db55559 --- /dev/null +++ b/java/.devcontainer/Dockerfile @@ -0,0 +1,15 @@ +FROM mcr.microsoft.com/devcontainers/java + +ARG MAVEN_VERSION=3.9.11 +ARG USER_HOME_DIR="/root" +ARG BASE_URL=https://dlcdn.apache.org/maven/maven-3/${MAVEN_VERSION}/binaries + +# Install Maven +RUN mkdir -p /usr/share/maven /usr/share/maven/ref \ + && curl -fsSL -o /tmp/apache-maven.tar.gz ${BASE_URL}/apache-maven-${MAVEN_VERSION}-bin.tar.gz \ + && tar -xzf /tmp/apache-maven.tar.gz -C /usr/share/maven --strip-components=1 \ + && rm -f /tmp/apache-maven.tar.gz \ + && ln -s /usr/share/maven/bin/mvn /usr/bin/mvn + +ENV MAVEN_HOME /usr/share/maven +ENV MAVEN_CONFIG "$USER_HOME_DIR/.m2" diff --git a/java/.devcontainer/devcontainer.json b/java/.devcontainer/devcontainer.json new file mode 100644 index 0000000..36a329b --- /dev/null +++ b/java/.devcontainer/devcontainer.json @@ -0,0 +1,7 @@ +{ + "name": "Devcontainer", + "build": { + // Path is relative to the devcontainer.json file. + "dockerfile": "Dockerfile" + } +} diff --git a/java/.env.example b/java/.env.example deleted file mode 100644 index 2665d9f..0000000 --- a/java/.env.example +++ /dev/null @@ -1,11 +0,0 @@ -# Global Payments API Configuration -# Copy this file to .env and fill in your credentials - -# GP-API Credentials (for reporting) -GP_API_APP_ID=your_app_id_here -GP_API_APP_KEY=your_app_key_here -GP_API_ENVIRONMENT=TEST - -# Legacy Credentials (for payment processing) -SECRET_API_KEY=your_secret_api_key_here -PUBLIC_API_KEY=your_public_api_key_here \ No newline at end of file diff --git a/java/.env.sample b/java/.env.sample index 9b3b549..e8057f3 100644 --- a/java/.env.sample +++ b/java/.env.sample @@ -1,4 +1,6 @@ # API Keys for Global Payments # Replace these sample values with your actual API keys -PUBLIC_API_KEY=pkapi_your_public_key_here -SECRET_API_KEY=skapi_your_secret_key_here + +# API Platform (GP API) +GP_API_APP_ID=4gPqnGBkppGYvoE5UX9EWQlotTxGUDbs #gitleaks:allow +GP_API_APP_KEY=FQyJA5VuEQfcji2M #gitleaks:allow \ No newline at end of file diff --git a/nodejs/.codesandbox/tasks.json b/nodejs/.codesandbox/tasks.json new file mode 100644 index 0000000..7f1da1b --- /dev/null +++ b/nodejs/.codesandbox/tasks.json @@ -0,0 +1,29 @@ +{ + // These tasks will run in order when initializing your CodeSandbox project. + "setupTasks": [ + { + "name": "Install Dependencies", + "command": "npm install" + }, + { + "name": "Create .env", + "command": "cp .env.sample .env" + } + ], + + // These tasks can be run from CodeSandbox. Running one will open a log in the app. + "tasks": { + "start": { + "name": "start", + "command": "npm start", + "runAtStart": true, + "preview": { + "port": 8000 + } + }, + "install": { + "name": "install dependencies", + "command": "npm install" + } + } +} diff --git a/nodejs/.codesandbox/template.json b/nodejs/.codesandbox/template.json new file mode 100644 index 0000000..8f2e0c3 --- /dev/null +++ b/nodejs/.codesandbox/template.json @@ -0,0 +1,7 @@ +{ + "title": "Global Payments Node.js", + "description": "The easiest way to get started from Docker in CodeSandbox", + "iconUrl": "https://globalpayments-samples.github.io/assets/img/g-symbol-dev-brand.png", + "tags": ["global-payments", "sample", "nodejs"], + "published": false +} diff --git a/nodejs/.devcontainer/devcontainer.json b/nodejs/.devcontainer/devcontainer.json new file mode 100644 index 0000000..3139d42 --- /dev/null +++ b/nodejs/.devcontainer/devcontainer.json @@ -0,0 +1,4 @@ +{ + "name": "Devcontainer", + "image": "ghcr.io/codesandbox/devcontainers/typescript-node:latest" +} diff --git a/nodejs/.env.sample b/nodejs/.env.sample index 9b3b549..e8057f3 100644 --- a/nodejs/.env.sample +++ b/nodejs/.env.sample @@ -1,4 +1,6 @@ # API Keys for Global Payments # Replace these sample values with your actual API keys -PUBLIC_API_KEY=pkapi_your_public_key_here -SECRET_API_KEY=skapi_your_secret_key_here + +# API Platform (GP API) +GP_API_APP_ID=4gPqnGBkppGYvoE5UX9EWQlotTxGUDbs #gitleaks:allow +GP_API_APP_KEY=FQyJA5VuEQfcji2M #gitleaks:allow \ No newline at end of file diff --git a/php/.codesandbox/tasks.json b/php/.codesandbox/tasks.json new file mode 100644 index 0000000..96088bb --- /dev/null +++ b/php/.codesandbox/tasks.json @@ -0,0 +1,29 @@ +{ + // These tasks will run in order when initializing your CodeSandbox project. + "setupTasks": [ + { + "name": "Install Dependencies", + "command": "composer install" + }, + { + "name": "Create .env", + "command": "cp .env.sample .env" + } + ], + + // These tasks can be run from CodeSandbox. Running one will open a log in the app. + "tasks": { + "start": { + "name": "start", + "command": "php -S 0.0.0.0:8000", + "runAtStart": true, + "preview": { + "port": 8000 + } + }, + "install": { + "name": "install dependencies", + "command": "composer install" + } + } +} diff --git a/php/.codesandbox/template.json b/php/.codesandbox/template.json new file mode 100644 index 0000000..8db7d73 --- /dev/null +++ b/php/.codesandbox/template.json @@ -0,0 +1,7 @@ +{ + "title": "Global Payments PHP", + "description": "The easiest way to get started from Docker in CodeSandbox", + "iconUrl": "https://globalpayments-samples.github.io/assets/img/g-symbol-dev-brand.png", + "tags": ["global-payments", "sample", "php"], + "published": false +} \ No newline at end of file diff --git a/php/.devcontainer/Dockerfile b/php/.devcontainer/Dockerfile new file mode 100644 index 0000000..267ba46 --- /dev/null +++ b/php/.devcontainer/Dockerfile @@ -0,0 +1,4 @@ +FROM mcr.microsoft.com/devcontainers/php:8.2 + +RUN ( curl -sSLf https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions -o - || echo 'return 1' ) | sh -s \ + intl \ No newline at end of file diff --git a/php/.devcontainer/devcontainer.json b/php/.devcontainer/devcontainer.json new file mode 100644 index 0000000..9065bcd --- /dev/null +++ b/php/.devcontainer/devcontainer.json @@ -0,0 +1,6 @@ +{ + "build": { + // Path is relative to the devcontainer.json file. + "dockerfile": "Dockerfile" + } +} diff --git a/php/.env.sample b/php/.env.sample index 9b3b549..e8057f3 100644 --- a/php/.env.sample +++ b/php/.env.sample @@ -1,4 +1,6 @@ # API Keys for Global Payments # Replace these sample values with your actual API keys -PUBLIC_API_KEY=pkapi_your_public_key_here -SECRET_API_KEY=skapi_your_secret_key_here + +# API Platform (GP API) +GP_API_APP_ID=4gPqnGBkppGYvoE5UX9EWQlotTxGUDbs #gitleaks:allow +GP_API_APP_KEY=FQyJA5VuEQfcji2M #gitleaks:allow \ No newline at end of file diff --git a/python/.env.sample b/python/.env.sample deleted file mode 100644 index 9b3b549..0000000 --- a/python/.env.sample +++ /dev/null @@ -1,4 +0,0 @@ -# API Keys for Global Payments -# Replace these sample values with your actual API keys -PUBLIC_API_KEY=pkapi_your_public_key_here -SECRET_API_KEY=skapi_your_secret_key_here diff --git a/python/.gitignore b/python/.gitignore deleted file mode 100644 index 2ad3777..0000000 --- a/python/.gitignore +++ /dev/null @@ -1,27 +0,0 @@ -## Python -__pycache__/ -*.py[cod] -*$py.class -*.so -.Python -env/ -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -*.egg-info/ -.installed.cfg -*.egg -venv/ -.env -.venv -.DS_Store -.idea/ -.vscode/ diff --git a/python/Dockerfile b/python/Dockerfile deleted file mode 100644 index 07f5380..0000000 --- a/python/Dockerfile +++ /dev/null @@ -1,24 +0,0 @@ -FROM python:3.11-slim - -WORKDIR /app - -# Install system dependencies -RUN apt-get update && \ - apt-get install -y --no-install-recommends \ - gcc \ - && rm -rf /var/lib/apt/lists/* - -# Copy requirements and install Python dependencies -COPY requirements.txt . -RUN pip install --no-cache-dir -r requirements.txt - -# Copy source code -COPY . . - -# Create non-root user -RUN useradd --create-home --shell /bin/bash app -USER app - -EXPOSE 8000 - -CMD ["python", "server.py"] \ No newline at end of file diff --git a/python/README.md b/python/README.md deleted file mode 100644 index f627631..0000000 --- a/python/README.md +++ /dev/null @@ -1,209 +0,0 @@ -# Global Payments Python Integration - -A comprehensive Python implementation for Global Payments payment processing and transaction reporting using Flask and the Global Payments Python SDK. - -## Requirements - -- Python 3.7 or later -- pip (Python Package Installer) -- Global Payments account and API credentials - -## Quick Start - -### 1. Configure Credentials - -Copy `.env.sample` to `.env` and add your credentials: - -```properties -# Payment Processing (Portico API) -PUBLIC_API_KEY=pkapi_cert_your_public_key -SECRET_API_KEY=skapi_cert_your_secret_key - -# Transaction Reporting (GP-API) -GP_API_APP_ID=your_app_id_here -GP_API_APP_KEY=your_app_key_here -GP_API_ENVIRONMENT=TEST # or PRODUCTION -``` - -### 2. Create Virtual Environment (Recommended) - -```bash -python -m venv venv -source venv/bin/activate # On Windows: venv\Scripts\activate -``` - -### 3. Install Dependencies - -```bash -pip install -r requirements.txt -``` - -### 4. Start the Server - -```bash -./run.sh -``` - -Or manually: -```bash -python server.py -``` - -The application will start on `http://localhost:8000` - -### 5. Verify Setup - -Open your browser to: -- **Web Interface**: http://localhost:8000/index.html -- **Get Public Key**: http://localhost:8000/config -- **Reporting Config**: http://localhost:8000/reports?action=config - -## Features - -### ✅ Payment Processing -- Process card payments with hosted fields tokenization -- Support for billing address verification (AVS) -- Real-time payment processing with Global Payments Portico API - -### ✅ Transaction Reporting -- Search and filter transactions -- Export data (JSON, CSV, XML) -- Generate settlement, dispute, and deposit reports -- Transaction analytics and summaries - -## API Endpoints - -### Payment Processing - -**Get Configuration** -```bash -curl http://localhost:8000/config -``` - -**Process Payment** -```bash -curl -X POST http://localhost:8000/process-payment \ - -H "Content-Type: application/json" \ - -d '{"payment_token":"YOUR_TOKEN","billing_zip":"12345","amount":"25.00"}' -``` - -### Transaction Reporting - -See [REPORTING_README.md](REPORTING_README.md) for complete reporting API documentation. - -**Quick Example - Search Transactions** -```bash -curl "http://localhost:8000/reports?action=search&start_date=2025-09-01&page_size=10" -``` - -## Project Structure - -``` -python/ -├── server.py # Main Flask application -├── reports.py # Reporting API endpoints -├── reporting_service.py # Reporting service logic -├── index.html # Payment form UI -├── requirements.txt # Python dependencies -├── .env # Your credentials (not in git) -├── .env.sample # Credential template -├── README.md # This file -└── REPORTING_README.md # Reporting API documentation -``` - -## Usage - -### Processing a Payment - -1. Open http://localhost:8000/index.html in your browser -2. Use test card: `4263970000005262` -3. Enter any future expiration date -4. Enter CVV: `123` -5. Enter billing ZIP code -6. Click "Pay $10.00" - -### Searching Transactions - -After processing payments, search for them: - -```bash -curl "http://localhost:8000/reports?action=search&page_size=20" -``` - -### Exporting Data - -Export transactions to CSV: - -```bash -curl "http://localhost:8000/reports?action=export&format=csv&start_date=2025-09-01" -o transactions.csv -``` - -## Testing - -### Test Card Numbers - -| Card Type | Number | CVV | Expiry | -|-----------|--------|-----|--------| -| Visa | 4263970000005262 | 123 | Any future date | -| Mastercard | 5425230000004415 | 123 | Any future date | -| Amex | 374101000000608 | 1234 | Any future date | - -### Testing Workflow - -1. **Process a payment** using the web interface -2. **Verify transaction** appears in reporting: - ```bash - curl "http://localhost:8000/reports?action=search" - ``` -3. **Get transaction details**: - ```bash - curl "http://localhost:8000/reports?action=detail&transaction_id=TRN_xxx" - ``` - -## Environment Variables - -| Variable | Required | Description | -|----------|----------|-------------| -| `PUBLIC_API_KEY` | Yes | Portico public API key for payment processing | -| `SECRET_API_KEY` | Yes | Portico secret API key for payment processing | -| `GP_API_APP_ID` | Yes | GP-API App ID for reporting | -| `GP_API_APP_KEY` | Yes | GP-API App Key for reporting | -| `GP_API_ENVIRONMENT` | No | TEST or PRODUCTION (default: TEST) | -| `PORT` | No | Server port (default: 8000) | - -## Troubleshooting - -**Port already in use?** -```bash -# Use a different port: -PORT=8080 python server.py -``` - -**Missing credentials error?** -- Ensure `.env` file exists in the `python/` directory -- Verify all required credentials are set -- Check for trailing spaces in credential values - -**Payment processing fails?** -- Verify `PUBLIC_API_KEY` and `SECRET_API_KEY` are correct -- Ensure using test credentials for test environment - -**Reporting not working?** -- Verify `GP_API_APP_ID` and `GP_API_APP_KEY` are correct -- These are different from payment processing credentials - -**Virtual environment issues?** -- Ensure virtual environment is activated -- Try recreating: `python -m venv venv --clear` - -## Documentation - -- **Payment Processing**: See API Endpoints section above -- **Transaction Reporting**: See [REPORTING_README.md](REPORTING_README.md) -- **Global Payments Docs**: https://developer.globalpay.com - -## Support - -For issues or questions: -- Global Payments Developer Portal: https://developer.globalpay.com -- SDK Documentation: https://github.com/globalpayments/python-sdk diff --git a/python/REPORTING_README.md b/python/REPORTING_README.md deleted file mode 100644 index 6f12caa..0000000 --- a/python/REPORTING_README.md +++ /dev/null @@ -1,292 +0,0 @@ -# Global Payments Reporting API - Python - -A comprehensive reporting service for Global Payments transactions with search, filtering, analytics, and data export capabilities. - -## Quick Start - -### 1. Configure Environment - -Create a `.env` file in the python directory: - -```properties -GP_API_APP_ID=your_app_id_here -GP_API_APP_KEY=your_app_key_here -GP_API_ENVIRONMENT=TEST # or PRODUCTION -``` - -### 2. Install Dependencies & Start Server - -```bash -cd python -pip install -r requirements.txt -python server.py -``` - -The API will be available at `http://localhost:8000/reports` - -### 3. Verify Configuration - -```bash -curl "http://localhost:8000/reports?action=config" -``` - -## API Endpoints - -All endpoints use `/reports?action={action_name}` and support both GET and POST requests. - -### Search Transactions - -Search and filter transactions with pagination. - -```bash -curl "http://localhost:8000/reports?action=search&start_date=2025-09-01&end_date=2025-09-30&page_size=20" -``` - -**Parameters**: -- `page` - Page number (default: 1) -- `page_size` - Results per page (default: 10, max: 100) -- `start_date` - Start date (YYYY-MM-DD) -- `end_date` - End date (YYYY-MM-DD) -- `transaction_id` - Specific transaction ID -- `payment_type` - Payment type filter -- `status` - Transaction status (e.g., CAPTURED, DECLINED) -- `amount_min` - Minimum amount -- `amount_max` - Maximum amount -- `card_last_four` - Last 4 digits of card - -### Get Transaction Details - -Retrieve detailed information for a specific transaction. - -```bash -curl "http://localhost:8000/reports?action=detail&transaction_id=TRN_123456" -``` - -**Required**: `transaction_id` - -### Settlement Report - -Get settlement information for a date range. - -```bash -curl "http://localhost:8000/reports?action=settlement&start_date=2025-09-01&end_date=2025-09-30" -``` - -**Parameters**: -- `page`, `page_size` - Pagination -- `start_date`, `end_date` - Date range - -### Export Transactions - -Export transaction data in JSON, CSV, or XML format. - -**CSV Export**: -```bash -curl "http://localhost:8000/reports?action=export&format=csv&start_date=2025-09-01&end_date=2025-09-30" -o transactions.csv -``` - -**XML Export**: -```bash -curl "http://localhost:8000/reports?action=export&format=xml&start_date=2025-09-01&end_date=2025-09-30" -o transactions.xml -``` - -**JSON Export**: -```bash -curl "http://localhost:8000/reports?action=export&format=json&start_date=2025-09-01&end_date=2025-09-30" -``` - -**Parameters**: -- `format` - Export format: `json`, `csv`, or `xml` (required) -- Plus all search filters - -### Summary Statistics - -Get aggregate statistics for transactions. - -```bash -curl "http://localhost:8000/reports?action=summary&start_date=2025-09-01&end_date=2025-09-30" -``` - -**Returns**: -- Total transaction count -- Total amount -- Average amount -- Status breakdown -- Payment type breakdown - -### Dispute Report - -Get dispute information with filtering. - -```bash -curl "http://localhost:8000/reports?action=disputes&start_date=2025-09-01&end_date=2025-09-30" -``` - -**Parameters**: -- `page`, `page_size` - Pagination -- `start_date`, `end_date` - Date range -- `stage` - Dispute stage -- `status` - Dispute status - -**Get Dispute Details**: -```bash -curl "http://localhost:8000/reports?action=dispute_detail&dispute_id=DIS_123456" -``` - -### Deposit Report - -Get deposit information and details. - -```bash -curl "http://localhost:8000/reports?action=deposits&start_date=2025-09-01&end_date=2025-09-30" -``` - -**Parameters**: -- `page`, `page_size` - Pagination -- `start_date`, `end_date` - Date range -- `deposit_id` - Filter by deposit ID -- `status` - Deposit status - -**Get Deposit Details**: -```bash -curl "http://localhost:8000/reports?action=deposit_detail&deposit_id=DEP_123456" -``` - -### Declined Transactions Report - -Get declined transactions with analysis. - -```bash -curl "http://localhost:8000/reports?action=declines&start_date=2025-09-01&end_date=2025-09-30" -``` - -**Returns** transaction data plus decline analysis: -- Decline reasons breakdown -- Card type breakdown -- Hourly decline patterns - -### Comprehensive Date Range Report - -Get a combined report across all transaction types. - -```bash -curl "http://localhost:8000/reports?action=date_range&start_date=2025-09-01&end_date=2025-09-30&transaction_limit=100" -``` - -**Parameters**: -- `start_date`, `end_date` - Date range -- `transaction_limit` - Max transactions (default: 100, max: 1000) -- `settlement_limit` - Max settlements (default: 50, max: 500) -- `dispute_limit` - Max disputes (default: 25, max: 100) -- `deposit_limit` - Max deposits (default: 25, max: 100) - -**Returns**: -- Transactions -- Settlements -- Disputes -- Deposits -- Comprehensive summary - -### Batch Report - -Get batch report information. - -```bash -curl "http://localhost:8000/reports?action=batches&start_date=2025-09-01&end_date=2025-09-30" -``` - -## Using POST with JSON - -All endpoints support POST requests with JSON body: - -```bash -curl -X POST http://localhost:8000/reports \ - -H "Content-Type: application/json" \ - -d '{ - "action": "search", - "start_date": "2025-09-01", - "end_date": "2025-09-30", - "page_size": 50, - "status": "CAPTURED" - }' -``` - -## Response Format - -### Success Response - -```json -{ - "success": true, - "data": { - "transactions": [...], - "pagination": { - "page": 1, - "page_size": 10, - "total_count": 42 - } - }, - "timestamp": "2025-10-01T12:00:00.123456" -} -``` - -### Error Response - -```json -{ - "success": false, - "error": { - "code": "ERROR_CODE", - "message": "Error description", - "timestamp": "2025-10-01T12:00:00.123456" - } -} -``` - -## Common Use Cases - -### Daily Transaction Report - -```bash -curl "http://localhost:8000/reports?action=summary&start_date=2025-09-30&end_date=2025-09-30" -``` - -### Find Specific Transaction - -```bash -curl "http://localhost:8000/reports?action=search&transaction_id=TRN_abc123" -``` - -### Export Monthly Transactions - -```bash -curl "http://localhost:8000/reports?action=export&format=csv&start_date=2025-09-01&end_date=2025-09-30" -o september_transactions.csv -``` - -### Analyze Declines - -```bash -curl "http://localhost:8000/reports?action=declines&start_date=2025-09-01&end_date=2025-09-30" -``` - -### Check Settlement Status - -```bash -curl "http://localhost:8000/reports?action=settlement&start_date=2025-09-30" -``` - -## Notes - -- **Date Format**: All dates must be in `YYYY-MM-DD` format -- **Pagination**: Page size is limited to 100 items maximum -- **Export Limits**: Exports are capped at 1000 transactions -- **Timestamps**: All response timestamps use ISO 8601 format -- **CORS**: Enabled for cross-origin requests - -## API Documentation - -View complete API documentation: - -```bash -curl http://localhost:8000/reports -``` diff --git a/python/documentation.html b/python/documentation.html deleted file mode 100644 index 24756b2..0000000 --- a/python/documentation.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - Transaction Reporting API Documentation - Python - - - - - - - - -
-
-
- - -
-
-
- -
- -

Transaction Reporting API

-

Query and export transaction data from Global Payments

- -
- ← Back to Dashboard -
- -
-
-

Setup

-

Add the following to your .env file:

- 
GP_API_APP_ID=your_app_id_here
-GP_API_APP_KEY=your_app_key_here
-

Install dependencies: pip install -r requirements.txt

-

Start server: python server.py

-
- -
-

Endpoints

-

Base URL: http://localhost:8000/api/reports?action=

- -

Search Transactions

-
- 
curl "http://localhost:8000/api/reports?action=search&start_date=2025-09-01&page_size=20"
-
- -

Parameters:

-
    -
  • page - Page number (default: 1)
    • -
  • page_size - Items per page (max: 100)
    • -
  • start_date - YYYY-MM-DD
    • -
  • end_date - YYYY-MM-DD
    • -
  • status - CAPTURED, DECLINED, PENDING, REVERSED
    • -
  • transaction_id - Specific transaction
    • -
  • amount_min / amount_max - Amount range
    • -
  • card_last_four - Last 4 card digits
    • -
- -

Transaction Details

-
- 
curl "http://localhost:8000/api/reports?action=detail&transaction_id=TRN_xxx"
-
- -

Export Data

-
-

CSV:

- 
curl "http://localhost:8000/api/reports?action=export&format=csv&start_date=2025-09-01" -o file.csv
- -

JSON:

- 
curl "http://localhost:8000/api/reports?action=export&format=json&start_date=2025-09-01" -o file.json
-
-
- Note: Exports up to 1000 records. Use filters to narrow results. -
- -

Summary Stats

-
- 
curl "http://localhost:8000/api/reports?action=summary&start_date=2025-09-01&end_date=2025-09-30"
-
-

Returns totals, averages, and breakdowns by status/payment type.

- -

Declined Transactions

-
- 
curl "http://localhost:8000/api/reports?action=declines&start_date=2025-09-01&page_size=20"
-
-

Returns declined transactions with analysis (reasons, card types, trends).

- -

Settlement Report

-
- 
curl "http://localhost:8000/api/reports?action=settlement&start_date=2025-09-01"
-
- -

Disputes

-
- 
curl "http://localhost:8000/api/reports?action=disputes&status=PENDING"
-
- -

Deposits

-
- 
curl "http://localhost:8000/api/reports?action=deposits&start_date=2025-09-01"
-
- -

Batches

-
- 
curl "http://localhost:8000/api/reports?action=batches&start_date=2025-09-01"
-
-
- -
-

Response Format

-

All responses follow this structure:

- -

Success Response:

- 
{
-  "success": true,
-  "data": { ... },
-  "timestamp": "2025-10-06 12:00:00"
-}
- -

Error Response:

- 
{
-  "success": false,
-  "error": {
-    "code": "VALIDATION_ERROR",
-    "message": "Invalid date format",
-    "timestamp": "2025-10-06 12:00:00"
-  }
-}
-
- -
-

Common Filters

-

All search endpoints support:

-
    -
  • Date ranges: start_date and end_date
    • -
  • Pagination: page and page_size
    • -
  • Status filtering where applicable
    • -
-
- -
-

Important Notes

-
-
    -
  • Dates must be YYYY-MM-DD format
    • -
  • Page size max is 100 (search/disputes/deposits)
    • -
  • Export limit is 1000 records
    • -
  • All timestamps are UTC
    • -
  • Transaction IDs start with TRN_
    • -
-
-
-
-
- - - - - - - diff --git a/python/index.html b/python/index.html deleted file mode 100644 index d4d0a70..0000000 --- a/python/index.html +++ /dev/null @@ -1,634 +0,0 @@ - - - - - - Global Payments - Developer Example - - - - - - - -
-
-
- - -
-
-
- -
- -

SDK Reporting Service

-

Comprehensive reporting service for Global Payments transactions, providing search, filtering, and export capabilities.

- - -
-
- - - -
- - -
-
-
-

Credit Card Payment Form

-

- Secure payment processing using Global Payments tokenization with client-side form validation. -

-
- -
-
- - -
- -
- - -
- -
- -
-
- - -
-
-
- - -
-
-
-

Reporting Operations

-

- Access comprehensive transaction reporting, search, and export functionality. -

-
- -
- Documentation: For detailed information on performing reporting operations, please refer to the REPORTING_README.md document. -
- -
-

Available Reporting Features:

-
    -
  • Transaction Search: Search and filter transactions by various criteria
    • -
  • Transaction Details: View detailed information for specific transactions
    • -
  • Summary Reports: Generate summaries with totals and statistics
    • -
  • Declined Transactions: Filter and analyze declined payments
    • -
  • Export Functionality: Export reports in CSV, JSON, and XML formats
    • -
-
- -
- - View Full Documentation - -
-
-
- - -
-
-
-

Transaction Report

-

- View recent transaction details in a simple table format. -

-
- - - - - -
- - - - -
- - -
-
- -
Loading transaction data...
-
-
- - - - - - -
-
-
-
- - - - - - - - - - \ No newline at end of file diff --git a/python/reporting_service.py b/python/reporting_service.py deleted file mode 100644 index f02cf1f..0000000 --- a/python/reporting_service.py +++ /dev/null @@ -1,1056 +0,0 @@ -""" -Global Payments Reporting Service - -This service class provides comprehensive reporting functionality for -Global Payments transactions including search, filtering, and data export. - -Python version 3.7 or higher -""" - -import os -from datetime import datetime -from typing import Dict, List, Any, Optional -from dotenv import load_dotenv - -from globalpayments.api import ServicesContainer -from globalpayments.api.services import ReportingService -from globalpayments.api.gateways import GpApiConfig -from globalpayments.api.entities.enums import ( - Environment, - Channel, - TransactionStatus, - PaymentType -) -from globalpayments.api.entities.exceptions import ApiException - - -class GlobalPaymentsReportingService: - """ - Global Payments Reporting Service Class - - Provides methods for transaction reporting, searching, and data export - using the Global Payments SDK reporting capabilities. - """ - - def __init__(self): - """Initialize and configure the SDK""" - self.is_configured = False - try: - self._configure_gp_api_sdk() - self.is_configured = True - except Exception as e: - raise ValueError(f'Failed to configure SDK: {str(e)}') - - def _configure_gp_api_sdk(self) -> None: - """Configure the SDK for GP-API with reporting capabilities""" - load_dotenv() - - # Validate required environment variables - required_vars = ['GP_API_APP_ID', 'GP_API_APP_KEY'] - for var in required_vars: - if not os.getenv(var): - raise ValueError(f"Missing required environment variable: {var}") - - config = GpApiConfig() - config.app_id = os.getenv('GP_API_APP_ID') - config.app_key = os.getenv('GP_API_APP_KEY') - config.environment = Environment.TEST # Change to PRODUCTION for live - config.channel = Channel.CardNotPresent - - ServicesContainer.configure(config, 'default') - - def _ensure_configured(self) -> None: - """Ensure SDK is properly configured""" - if not self.is_configured: - raise RuntimeError('SDK is not properly configured') - - def search_transactions(self, filters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: - """ - Search transactions with filters and pagination - - Args: - filters: Search filters and pagination parameters - - Returns: - Transaction search results - """ - self._ensure_configured() - - if filters is None: - filters = {} - - try: - page = filters.get('page', 1) - page_size = filters.get('page_size', 10) - - report_builder = ReportingService.find_transactions_paged(page, page_size) - - # Apply date range filters - if filters.get('start_date'): - start_date = datetime.strptime(filters['start_date'], '%Y-%m-%d') - report_builder.with_start_date(start_date) - - if filters.get('end_date'): - end_date = datetime.strptime(filters['end_date'], '%Y-%m-%d') - report_builder.with_end_date(end_date) - - # Apply transaction ID filter - if filters.get('transaction_id'): - report_builder.with_transaction_id(filters['transaction_id']) - - # Apply payment type filter - if filters.get('payment_type'): - payment_type = self._map_payment_type(filters['payment_type']) - if payment_type: - report_builder.with_payment_type(payment_type) - - # Apply amount range filters - if filters.get('amount_min'): - report_builder.with_amount(float(filters['amount_min'])) - - if filters.get('amount_max'): - report_builder.with_amount(float(filters['amount_max'])) - - # Apply card number filter (last 4 digits) - if filters.get('card_last_four'): - report_builder.with_card_number_last_four(filters['card_last_four']) - - # Execute the search - response = report_builder.execute() - - transactions = self._format_transaction_list(response.results if response.results else []) - - # Apply client-side filtering for status if needed - if filters.get('status'): - status_filter = filters['status'].upper() - transactions = [t for t in transactions if t.get('status', '').upper() == status_filter] - - return { - 'success': True, - 'data': { - 'transactions': transactions, - 'pagination': { - 'page': page, - 'page_size': page_size, - 'total_count': len(transactions), - 'original_total_count': response.total_record_count if hasattr(response, 'total_record_count') else 0 - } - }, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except ApiException as e: - raise ApiException(f'Transaction search failed: {str(e)}') - - def get_transaction_details(self, transaction_id: str) -> Dict[str, Any]: - """ - Get detailed information for a specific transaction - - Args: - transaction_id: The transaction ID to retrieve - - Returns: - Transaction details - """ - self._ensure_configured() - - try: - report_builder = ReportingService.transaction_detail(transaction_id) - response = report_builder.execute() - - if not response: - raise ApiException('Transaction not found') - - return { - 'success': True, - 'data': self._format_transaction_details(response), - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except ApiException as e: - raise ApiException(f'Failed to retrieve transaction details: {str(e)}') - - def get_settlement_report(self, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: - """ - Generate settlement report for a date range - - Args: - params: Report parameters - - Returns: - Settlement report data - """ - self._ensure_configured() - - if params is None: - params = {} - - try: - page = params.get('page', 1) - page_size = params.get('page_size', 50) - - report_builder = ReportingService.find_settlement_transactions_paged(page, page_size) - - # Apply date range - if params.get('start_date'): - start_date = datetime.strptime(params['start_date'], '%Y-%m-%d') - report_builder.with_start_date(start_date) - - if params.get('end_date'): - end_date = datetime.strptime(params['end_date'], '%Y-%m-%d') - report_builder.with_end_date(end_date) - - response = report_builder.execute() - - settlements = self._format_settlement_list(response.results if response.results else []) - - return { - 'success': True, - 'data': { - 'settlements': settlements, - 'summary': self._generate_settlement_summary(response.results if response.results else []), - 'pagination': { - 'page': page, - 'page_size': page_size, - 'total_count': response.total_record_count if hasattr(response, 'total_record_count') else 0 - } - }, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except ApiException as e: - raise ApiException(f'Settlement report generation failed: {str(e)}') - - def get_dispute_report(self, filters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: - """ - Get dispute reports with filtering and pagination - - Args: - filters: Dispute search filters and pagination - - Returns: - Dispute report results - """ - self._ensure_configured() - - if filters is None: - filters = {} - - try: - page = filters.get('page', 1) - page_size = filters.get('page_size', 10) - - report_builder = ReportingService.find_disputes_paged(page, page_size) - - # Apply date range filters - if filters.get('start_date'): - start_date = datetime.strptime(filters['start_date'], '%Y-%m-%d') - report_builder.with_start_date(start_date) - - if filters.get('end_date'): - end_date = datetime.strptime(filters['end_date'], '%Y-%m-%d') - report_builder.with_end_date(end_date) - - # Apply dispute stage filter - if filters.get('stage'): - report_builder.with_dispute_stage(filters['stage']) - - # Apply dispute status filter - if filters.get('status'): - report_builder.with_dispute_status(filters['status']) - - # Execute the search - response = report_builder.execute() - - return { - 'success': True, - 'data': { - 'disputes': self._format_dispute_list(response.results if response.results else []), - 'pagination': { - 'page': page, - 'page_size': page_size, - 'total_count': response.total_record_count if hasattr(response, 'total_record_count') else 0 - } - }, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except ApiException as e: - raise ApiException(f'Dispute report generation failed: {str(e)}') - - def get_dispute_details(self, dispute_id: str) -> Dict[str, Any]: - """ - Get detailed information for a specific dispute - - Args: - dispute_id: The dispute ID to retrieve - - Returns: - Dispute details - """ - self._ensure_configured() - - try: - report_builder = ReportingService.dispute_detail(dispute_id) - response = report_builder.execute() - - if not response: - raise ApiException('Dispute not found') - - return { - 'success': True, - 'data': self._format_dispute_details(response), - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except ApiException as e: - raise ApiException(f'Failed to retrieve dispute details: {str(e)}') - - def get_deposit_report(self, filters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: - """ - Get deposit reports with filtering and pagination - - Args: - filters: Deposit search filters and pagination - - Returns: - Deposit report results - """ - self._ensure_configured() - - if filters is None: - filters = {} - - try: - page = filters.get('page', 1) - page_size = filters.get('page_size', 10) - - report_builder = ReportingService.find_deposits_paged(page, page_size) - - # Apply date range filters - if filters.get('start_date'): - start_date = datetime.strptime(filters['start_date'], '%Y-%m-%d') - report_builder.with_start_date(start_date) - - if filters.get('end_date'): - end_date = datetime.strptime(filters['end_date'], '%Y-%m-%d') - report_builder.with_end_date(end_date) - - # Apply deposit ID filter - if filters.get('deposit_id'): - report_builder.with_deposit_reference(filters['deposit_id']) - - # Apply status filter - if filters.get('status'): - report_builder.with_deposit_status(filters['status']) - - # Execute the search - response = report_builder.execute() - - return { - 'success': True, - 'data': { - 'deposits': self._format_deposit_list(response.results if response.results else []), - 'pagination': { - 'page': page, - 'page_size': page_size, - 'total_count': response.total_record_count if hasattr(response, 'total_record_count') else 0 - } - }, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except ApiException as e: - raise ApiException(f'Deposit report generation failed: {str(e)}') - - def get_deposit_details(self, deposit_id: str) -> Dict[str, Any]: - """ - Get detailed information for a specific deposit - - Args: - deposit_id: The deposit ID to retrieve - - Returns: - Deposit details - """ - self._ensure_configured() - - try: - report_builder = ReportingService.deposit_detail(deposit_id) - response = report_builder.execute() - - if not response: - raise ApiException('Deposit not found') - - return { - 'success': True, - 'data': self._format_deposit_details(response), - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except ApiException as e: - raise ApiException(f'Failed to retrieve deposit details: {str(e)}') - - def get_batch_report(self, filters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: - """ - Get batch report with detailed transaction information - - Args: - filters: Batch search filters - - Returns: - Batch report results - """ - self._ensure_configured() - - if filters is None: - filters = {} - - try: - report_builder = ReportingService.batch_detail() - - # Apply date range filters - if filters.get('start_date'): - start_date = datetime.strptime(filters['start_date'], '%Y-%m-%d') - report_builder.with_start_date(start_date) - - if filters.get('end_date'): - end_date = datetime.strptime(filters['end_date'], '%Y-%m-%d') - report_builder.with_end_date(end_date) - - # Execute the search - response = report_builder.execute() - - batches = response.results if response.results else [] - - return { - 'success': True, - 'data': { - 'batches': self._format_batch_list(batches), - 'summary': self._generate_batch_summary(batches) - }, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except ApiException as e: - raise ApiException(f'Batch report generation failed: {str(e)}') - - def get_declined_transactions_report(self, filters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: - """ - Get declined transactions report - - Args: - filters: Decline search filters and pagination - - Returns: - Declined transactions report - """ - self._ensure_configured() - - if filters is None: - filters = {} - - try: - # Use transaction search with declined status filter - decline_filters = {**filters, 'status': 'DECLINED'} - result = self.search_transactions(decline_filters) - - # Add decline analysis - if result['success']: - result['data']['decline_analysis'] = self._analyze_declines(result['data']['transactions']) - - return result - - except ApiException as e: - raise ApiException(f'Declined transactions report generation failed: {str(e)}') - - def get_date_range_report(self, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: - """ - Get comprehensive date range report across all transaction types - - Args: - params: Date range and report parameters - - Returns: - Comprehensive date range report - """ - self._ensure_configured() - - if params is None: - params = {} - - try: - from datetime import timedelta - - start_date = params.get('start_date', (datetime.now() - timedelta(days=30)).strftime('%Y-%m-%d')) - end_date = params.get('end_date', datetime.now().strftime('%Y-%m-%d')) - - report = { - 'success': True, - 'data': { - 'period': { - 'start_date': start_date, - 'end_date': end_date - }, - 'transactions': {}, - 'settlements': {}, - 'disputes': {}, - 'deposits': {}, - 'summary': {} - }, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - # Get transactions for the period - try: - transaction_result = self.search_transactions({ - 'start_date': start_date, - 'end_date': end_date, - 'page_size': params.get('transaction_limit', 100) - }) - if transaction_result['success']: - report['data']['transactions'] = transaction_result['data'] - except Exception as e: - report['data']['transactions'] = {'error': f'Transactions not available: {str(e)}'} - - # Get settlements for the period - try: - settlement_result = self.get_settlement_report({ - 'start_date': start_date, - 'end_date': end_date, - 'page_size': params.get('settlement_limit', 50) - }) - if settlement_result['success']: - report['data']['settlements'] = settlement_result['data'] - except Exception as e: - report['data']['settlements'] = {'error': f'Settlements not available: {str(e)}'} - - # Get disputes for the period - try: - dispute_result = self.get_dispute_report({ - 'start_date': start_date, - 'end_date': end_date, - 'page_size': params.get('dispute_limit', 25) - }) - if dispute_result['success']: - report['data']['disputes'] = dispute_result['data'] - except Exception as e: - report['data']['disputes'] = {'error': f'Disputes not available: {str(e)}'} - - # Get deposits for the period - try: - deposit_result = self.get_deposit_report({ - 'start_date': start_date, - 'end_date': end_date, - 'page_size': params.get('deposit_limit', 25) - }) - if deposit_result['success']: - report['data']['deposits'] = deposit_result['data'] - except Exception as e: - report['data']['deposits'] = {'error': f'Deposits not available: {str(e)}'} - - # Generate comprehensive summary - report['data']['summary'] = self._generate_comprehensive_summary(report['data']) - - return report - - except Exception as e: - return { - 'success': False, - 'error': f'Failed to generate date range report: {str(e)}', - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - def export_transactions(self, filters: Optional[Dict[str, Any]] = None, format: str = 'json') -> Dict[str, Any]: - """ - Export transaction data in specified format - - Args: - filters: Search filters - format: Export format ('json', 'csv', or 'xml') - - Returns: - Export data - """ - self._ensure_configured() - - if filters is None: - filters = {} - - try: - # Get all transactions (remove pagination for export) - export_filters = {**filters, 'page_size': 1000} - - transactions = self.search_transactions(export_filters) - - if format == 'csv': - return self._export_to_csv(transactions['data']['transactions']) - elif format == 'xml': - return self._export_to_xml(transactions['data']['transactions']) - - return { - 'success': True, - 'data': transactions['data']['transactions'], - 'format': 'json', - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except ApiException as e: - raise ApiException(f'Export failed: {str(e)}') - - def get_summary_stats(self, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: - """ - Get reporting summary statistics - - Args: - params: Summary parameters - - Returns: - Summary statistics - """ - self._ensure_configured() - - if params is None: - params = {} - - try: - from datetime import timedelta - - start_date = params.get('start_date', (datetime.now() - timedelta(days=30)).strftime('%Y-%m-%d')) - end_date = params.get('end_date', datetime.now().strftime('%Y-%m-%d')) - - # Get transaction summary - transactions = self.search_transactions({ - 'start_date': start_date, - 'end_date': end_date, - 'page_size': 1000 - }) - - return { - 'success': True, - 'data': self._calculate_summary_stats(transactions['data']['transactions']), - 'period': { - 'start_date': start_date, - 'end_date': end_date - }, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - except Exception as e: - return { - 'success': False, - 'error': f'Failed to generate summary statistics: {str(e)}', - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - # Helper methods for mapping and formatting - - def _map_payment_type(self, payment_type: str) -> Optional[PaymentType]: - """Map payment type string to PaymentType enum""" - mapping = { - 'sale': PaymentType.Sale, - 'refund': PaymentType.Refund, - 'authorize': PaymentType.Auth, - 'capture': PaymentType.Capture - } - return mapping.get(payment_type.lower()) - - def _format_transaction_list(self, transactions: List[Any]) -> List[Dict[str, Any]]: - """Format transaction list for API response""" - return [ - { - 'transaction_id': getattr(t, 'transaction_id', ''), - 'timestamp': str(getattr(t, 'transaction_date', '')), - 'amount': getattr(t, 'amount', 0), - 'currency': getattr(t, 'currency', 'USD'), - 'status': getattr(t, 'transaction_status', ''), - 'payment_method': getattr(t, 'payment_type', ''), - 'card_last_four': getattr(t, 'masked_card_number', ''), - 'auth_code': getattr(t, 'auth_code', ''), - 'reference_number': getattr(t, 'reference_number', '') - } - for t in transactions - ] - - def _format_transaction_details(self, transaction: Any) -> Dict[str, Any]: - """Format detailed transaction information""" - return { - 'transaction_id': getattr(transaction, 'transaction_id', ''), - 'timestamp': str(getattr(transaction, 'transaction_date', '')), - 'amount': getattr(transaction, 'amount', 0), - 'currency': getattr(transaction, 'currency', 'USD'), - 'status': getattr(transaction, 'transaction_status', ''), - 'payment_method': getattr(transaction, 'payment_type', ''), - 'card_details': { - 'masked_number': getattr(transaction, 'masked_card_number', ''), - 'card_type': getattr(transaction, 'card_type', ''), - 'entry_mode': getattr(transaction, 'entry_mode', '') - }, - 'auth_code': getattr(transaction, 'auth_code', ''), - 'reference_number': getattr(transaction, 'reference_number', ''), - 'gateway_response_code': getattr(transaction, 'gateway_response_code', ''), - 'gateway_response_message': getattr(transaction, 'gateway_response_message', '') - } - - def _format_settlement_list(self, settlements: List[Any]) -> List[Dict[str, Any]]: - """Format settlement list for API response""" - return [ - { - 'settlement_id': getattr(s, 'settlement_id', ''), - 'settlement_date': str(getattr(s, 'settlement_date', '')), - 'transaction_count': getattr(s, 'transaction_count', 0), - 'total_amount': getattr(s, 'total_amount', 0), - 'currency': getattr(s, 'currency', 'USD'), - 'status': getattr(s, 'status', '') - } - for s in settlements - ] - - def _generate_settlement_summary(self, settlements: List[Any]) -> Dict[str, Any]: - """Generate settlement summary statistics""" - total_amount = sum(getattr(s, 'total_amount', 0) for s in settlements) - total_transactions = sum(getattr(s, 'transaction_count', 0) for s in settlements) - - return { - 'total_settlements': len(settlements), - 'total_amount': total_amount, - 'total_transactions': total_transactions, - 'average_settlement_amount': total_amount / len(settlements) if settlements else 0 - } - - def _format_dispute_list(self, disputes: List[Any]) -> List[Dict[str, Any]]: - """Format dispute list for API response""" - return [ - { - 'dispute_id': getattr(d, 'case_id', ''), - 'transaction_id': getattr(d, 'transaction_id', ''), - 'case_number': getattr(d, 'case_number', ''), - 'dispute_stage': getattr(d, 'case_stage', ''), - 'dispute_status': getattr(d, 'case_status', ''), - 'case_amount': getattr(d, 'case_amount', 0), - 'currency': getattr(d, 'case_currency', 'USD'), - 'reason_code': getattr(d, 'reason_code', ''), - 'reason_description': getattr(d, 'reason', ''), - 'case_time': str(getattr(d, 'case_time', '')), - 'last_adjustment_time': str(getattr(d, 'last_adjustment_time', '')) - } - for d in disputes - ] - - def _format_dispute_details(self, dispute: Any) -> Dict[str, Any]: - """Format detailed dispute information""" - return { - 'dispute_id': getattr(dispute, 'case_id', ''), - 'transaction_id': getattr(dispute, 'transaction_id', ''), - 'case_number': getattr(dispute, 'case_number', ''), - 'dispute_stage': getattr(dispute, 'case_stage', ''), - 'dispute_status': getattr(dispute, 'case_status', ''), - 'case_amount': getattr(dispute, 'case_amount', 0), - 'currency': getattr(dispute, 'case_currency', 'USD'), - 'reason_code': getattr(dispute, 'reason_code', ''), - 'reason_description': getattr(dispute, 'reason', ''), - 'case_time': str(getattr(dispute, 'case_time', '')), - 'last_adjustment_time': str(getattr(dispute, 'last_adjustment_time', '')), - 'case_description': getattr(dispute, 'case_description', ''), - 'documents': getattr(dispute, 'documents', []), - 'transaction_details': { - 'amount': getattr(dispute, 'transaction_amount', 0), - 'currency': getattr(dispute, 'transaction_currency', 'USD'), - 'masked_card_number': getattr(dispute, 'transaction_masked_card_number', ''), - 'arn': getattr(dispute, 'transaction_arn', '') - } - } - - def _format_deposit_list(self, deposits: List[Any]) -> List[Dict[str, Any]]: - """Format deposit list for API response""" - return [ - { - 'deposit_id': getattr(d, 'deposit_id', ''), - 'deposit_date': str(getattr(d, 'deposit_date', '')), - 'deposit_reference': getattr(d, 'deposit_reference', ''), - 'deposit_status': getattr(d, 'status', ''), - 'deposit_amount': getattr(d, 'amount', 0), - 'currency': getattr(d, 'currency', 'USD'), - 'merchant_number': getattr(d, 'merchant_number', ''), - 'merchant_hierarchy': getattr(d, 'merchant_hierarchy', ''), - 'sales_count': getattr(d, 'sales_count', 0), - 'sales_amount': getattr(d, 'sales_amount', 0), - 'refunds_count': getattr(d, 'refunds_count', 0), - 'refunds_amount': getattr(d, 'refunds_amount', 0) - } - for d in deposits - ] - - def _format_deposit_details(self, deposit: Any) -> Dict[str, Any]: - """Format detailed deposit information""" - return { - 'deposit_id': getattr(deposit, 'deposit_id', ''), - 'deposit_date': str(getattr(deposit, 'deposit_date', '')), - 'deposit_reference': getattr(deposit, 'deposit_reference', ''), - 'deposit_status': getattr(deposit, 'status', ''), - 'deposit_amount': getattr(deposit, 'amount', 0), - 'currency': getattr(deposit, 'currency', 'USD'), - 'merchant_number': getattr(deposit, 'merchant_number', ''), - 'merchant_hierarchy': getattr(deposit, 'merchant_hierarchy', ''), - 'bank_account': { - 'masked_account_number': getattr(deposit, 'masked_account_number', ''), - 'bank_name': getattr(deposit, 'bank_name', '') - }, - 'transaction_summary': { - 'sales_count': getattr(deposit, 'sales_count', 0), - 'sales_amount': getattr(deposit, 'sales_amount', 0), - 'refunds_count': getattr(deposit, 'refunds_count', 0), - 'refunds_amount': getattr(deposit, 'refunds_amount', 0), - 'chargebacks_count': getattr(deposit, 'chargebacks_count', 0), - 'chargebacks_amount': getattr(deposit, 'chargebacks_amount', 0), - 'adjustments_count': getattr(deposit, 'adjustments_count', 0), - 'adjustments_amount': getattr(deposit, 'adjustments_amount', 0) - } - } - - def _format_batch_list(self, batches: List[Any]) -> List[Dict[str, Any]]: - """Format batch list for API response""" - return [ - { - 'batch_id': getattr(b, 'batch_id', ''), - 'sequence_number': getattr(b, 'sequence_number', ''), - 'transaction_count': getattr(b, 'transaction_count', 0), - 'total_amount': getattr(b, 'total_amount', 0), - 'currency': getattr(b, 'currency', 'USD'), - 'batch_status': getattr(b, 'batch_status', ''), - 'close_time': str(getattr(b, 'close_time', '')), - 'open_time': str(getattr(b, 'open_time', '')) - } - for b in batches - ] - - def _generate_batch_summary(self, batches: List[Any]) -> Dict[str, Any]: - """Generate batch summary statistics""" - total_amount = sum(getattr(b, 'total_amount', 0) for b in batches) - total_transactions = sum(getattr(b, 'transaction_count', 0) for b in batches) - - batch_statuses = {} - for batch in batches: - status = getattr(batch, 'batch_status', 'unknown') - batch_statuses[status] = batch_statuses.get(status, 0) + 1 - - return { - 'total_batches': len(batches), - 'total_amount': total_amount, - 'total_transactions': total_transactions, - 'average_batch_amount': total_amount / len(batches) if batches else 0, - 'status_breakdown': batch_statuses - } - - def _calculate_summary_stats(self, transactions: List[Dict[str, Any]]) -> Dict[str, Any]: - """Calculate summary statistics from transaction data""" - total_amount = sum(t.get('amount', 0) for t in transactions) - - status_counts = {} - payment_type_counts = {} - - for transaction in transactions: - status = transaction.get('status', 'unknown') - status_counts[status] = status_counts.get(status, 0) + 1 - - payment_type = transaction.get('payment_method', 'unknown') - payment_type_counts[payment_type] = payment_type_counts.get(payment_type, 0) + 1 - - return { - 'total_transactions': len(transactions), - 'total_amount': total_amount, - 'average_amount': total_amount / len(transactions) if transactions else 0, - 'status_breakdown': status_counts, - 'payment_type_breakdown': payment_type_counts - } - - def _analyze_declines(self, transactions: List[Dict[str, Any]]) -> Dict[str, Any]: - """Analyze decline patterns from transaction data""" - decline_reasons = {} - card_types = {} - hourly_breakdown = {} - total_amount = 0 - - for transaction in transactions: - # Analyze decline reasons - reason = transaction.get('gateway_response_message', 'Unknown') - decline_reasons[reason] = decline_reasons.get(reason, 0) + 1 - - # Analyze card types - card_type = transaction.get('payment_method', 'Unknown') - card_types[card_type] = card_types.get(card_type, 0) + 1 - - # Analyze hourly patterns - timestamp = transaction.get('timestamp', '') - if timestamp: - try: - hour = datetime.strptime(str(timestamp)[:19], '%Y-%m-%d %H:%M:%S').strftime('%H') - hourly_breakdown[hour] = hourly_breakdown.get(hour, 0) + 1 - except: - pass - - total_amount += transaction.get('amount', 0) - - return { - 'total_declined_transactions': len(transactions), - 'total_declined_amount': total_amount, - 'average_declined_amount': total_amount / len(transactions) if transactions else 0, - 'decline_reasons': decline_reasons, - 'card_type_breakdown': card_types, - 'hourly_breakdown': hourly_breakdown - } - - def _generate_comprehensive_summary(self, report_data: Dict[str, Any]) -> Dict[str, Any]: - """Generate comprehensive summary for date range report""" - summary = { - 'overview': {}, - 'financial_summary': {}, - 'operational_metrics': {} - } - - # Transaction overview - if report_data.get('transactions', {}).get('transactions'): - transactions = report_data['transactions']['transactions'] - transaction_count = len(transactions) - total_amount = sum(t.get('amount', 0) for t in transactions) - - summary['overview']['transactions'] = { - 'count': transaction_count, - 'total_amount': total_amount, - 'average_amount': total_amount / transaction_count if transaction_count else 0 - } - - # Settlement summary - if report_data.get('settlements', {}).get('settlements'): - settlements = report_data['settlements']['settlements'] - settlement_count = len(settlements) - settled_amount = sum(s.get('total_amount', 0) for s in settlements) - - summary['financial_summary']['settlements'] = { - 'count': settlement_count, - 'total_amount': settled_amount - } - - # Dispute summary - if report_data.get('disputes', {}).get('disputes'): - disputes = report_data['disputes']['disputes'] - dispute_count = len(disputes) - dispute_amount = sum(d.get('case_amount', 0) for d in disputes) - - transaction_count = summary.get('overview', {}).get('transactions', {}).get('count', 0) - dispute_rate = (dispute_count / transaction_count * 100) if transaction_count else 0 - - summary['operational_metrics']['disputes'] = { - 'count': dispute_count, - 'total_amount': dispute_amount, - 'dispute_rate': dispute_rate - } - - # Deposit summary - if report_data.get('deposits', {}).get('deposits'): - deposits = report_data['deposits']['deposits'] - deposit_count = len(deposits) - deposit_amount = sum(d.get('deposit_amount', 0) for d in deposits) - - summary['financial_summary']['deposits'] = { - 'count': deposit_count, - 'total_amount': deposit_amount - } - - return summary - - def _export_to_csv(self, transactions: List[Dict[str, Any]]) -> Dict[str, Any]: - """Export transaction data to CSV format""" - csv_data = "Transaction ID,Timestamp,Amount,Currency,Status,Payment Method,Card Last Four,Auth Code,Reference Number\n" - - for transaction in transactions: - csv_data += f"{transaction.get('transaction_id', '')}," - csv_data += f"{transaction.get('timestamp', '')}," - csv_data += f"{transaction.get('amount', '')}," - csv_data += f"{transaction.get('currency', '')}," - csv_data += f"{transaction.get('status', '')}," - csv_data += f"{transaction.get('payment_method', '')}," - csv_data += f"{transaction.get('card_last_four', '')}," - csv_data += f"{transaction.get('auth_code', '')}," - csv_data += f"{transaction.get('reference_number', '')}\n" - - return { - 'success': True, - 'data': csv_data, - 'format': 'csv', - 'filename': f'transactions_{datetime.now().strftime("%Y-%m-%d_%H-%M-%S")}.csv', - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - def _export_to_xml(self, transactions: List[Dict[str, Any]]) -> Dict[str, Any]: - """Export transaction data to XML format""" - xml_data = '\n\n' - - for transaction in transactions: - xml_data += ' \n' - xml_data += f' {transaction.get("transaction_id", "")}\n' - xml_data += f' {transaction.get("timestamp", "")}\n' - xml_data += f' {transaction.get("amount", "")}\n' - xml_data += f' {transaction.get("currency", "")}\n' - xml_data += f' {transaction.get("status", "")}\n' - xml_data += f' {transaction.get("payment_method", "")}\n' - xml_data += f' {transaction.get("card_last_four", "")}\n' - xml_data += f' {transaction.get("auth_code", "")}\n' - xml_data += f' {transaction.get("reference_number", "")}\n' - xml_data += ' \n' - - xml_data += '' - - return { - 'success': True, - 'data': xml_data, - 'format': 'xml', - 'filename': f'transactions_{datetime.now().strftime("%Y-%m-%d_%H-%M-%S")}.xml', - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - -def get_sdk_config_status() -> Dict[str, Any]: - """Get current SDK configuration status""" - try: - has_app_id = bool(os.getenv('GP_API_APP_ID')) - has_app_key = bool(os.getenv('GP_API_APP_KEY')) - is_configured = has_app_id and has_app_key - - return { - 'configured': is_configured, - 'has_app_id': has_app_id, - 'has_app_key': has_app_key, - 'environment': 'TEST' if is_configured else 'Not configured', - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - except Exception as e: - return { - 'configured': False, - 'error': str(e), - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - - -def validate_environment_config() -> Dict[str, Any]: - """Validate environment configuration""" - results = { - 'valid': True, - 'errors': [], - 'warnings': [] - } - - # Check required variables - required = ['GP_API_APP_ID', 'GP_API_APP_KEY'] - for var in required: - if not os.getenv(var): - results['valid'] = False - results['errors'].append(f"Missing required environment variable: {var}") - - # Check legacy variables and warn if present - legacy = ['PUBLIC_API_KEY', 'SECRET_API_KEY'] - for var in legacy: - if os.getenv(var): - results['warnings'].append(f"Legacy variable {var} found. GP-API uses GP_API_APP_ID and GP_API_APP_KEY.") - - return results \ No newline at end of file diff --git a/python/reports.py b/python/reports.py deleted file mode 100644 index af31bff..0000000 --- a/python/reports.py +++ /dev/null @@ -1,557 +0,0 @@ -""" -Global Payments Reporting API Endpoint - -This script provides RESTful API endpoints for accessing Global Payments -reporting functionality including transaction search, details, settlement -reports, and data export capabilities. - -Python version 3.7 or higher -""" - -from flask import Blueprint, request, jsonify, Response -from datetime import datetime -from typing import Dict, Any - -from reporting_service import ( - GlobalPaymentsReportingService, - get_sdk_config_status, - validate_environment_config -) -from globalpayments.api.entities.exceptions import ApiException - - -# Create a Blueprint for reporting routes -reports_bp = Blueprint('reports', __name__) - - -def get_request_params() -> Dict[str, Any]: - """ - Get request parameters (supports both GET and POST) - - Returns: - Combined request parameters - """ - params = dict(request.args) - - if request.method == 'POST': - if request.is_json: - params.update(request.json or {}) - else: - params.update(request.form.to_dict()) - - return params - - -def validate_required_params(params: Dict[str, Any], required: list) -> None: - """ - Validate required parameters - - Args: - params: Request parameters - required: Required parameter names - - Raises: - ValueError: If required parameters are missing - """ - for param in required: - if param not in params or params[param] == '': - raise ValueError(f"Missing required parameter: {param}") - - -def validate_date_format(date_str: str, date_format: str = '%Y-%m-%d') -> bool: - """ - Validate date format - - Args: - date_str: Date string - date_format: Expected date format - - Returns: - True if valid - """ - try: - datetime.strptime(date_str, date_format) - return True - except ValueError: - return False - - -def handle_error(message: str, status_code: int = 400, error_code: str = 'API_ERROR') -> tuple: - """ - Handle error responses - - Args: - message: Error message - status_code: HTTP status code - error_code: Error code - - Returns: - JSON response and status code tuple - """ - return jsonify({ - 'success': False, - 'error': { - 'code': error_code, - 'message': message, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - } - }), status_code - - -def filter_empty_params(params: Dict[str, Any]) -> Dict[str, Any]: - """ - Remove empty parameters from dictionary - - Args: - params: Parameters dictionary - - Returns: - Filtered parameters - """ - return {k: v for k, v in params.items() if v not in ('', None)} - - -@reports_bp.route('/', methods=['GET', 'POST', 'OPTIONS']) -@reports_bp.route('/reports', methods=['GET', 'POST', 'OPTIONS']) -def reports_handler(): - """Main reports endpoint handler""" - # Handle preflight OPTIONS request - if request.method == 'OPTIONS': - return '', 200 - - try: - # Initialize the reporting service - reporting_service = GlobalPaymentsReportingService() - - # Get request parameters - params = get_request_params() - action = params.get('action', '') - - # Route requests based on action parameter - if action == 'search': - # Search transactions - filters = { - 'page': int(params.get('page', 1)), - 'page_size': min(int(params.get('page_size', 10)), 100), # Limit page size - 'start_date': params.get('start_date', ''), - 'end_date': params.get('end_date', ''), - 'transaction_id': params.get('transaction_id', ''), - 'payment_type': params.get('payment_type', ''), - 'status': params.get('status', ''), - 'amount_min': params.get('amount_min', ''), - 'amount_max': params.get('amount_max', ''), - 'card_last_four': params.get('card_last_four', '') - } - - # Validate date formats if provided - if filters['start_date'] and not validate_date_format(filters['start_date']): - raise ValueError('Invalid start_date format. Use YYYY-MM-DD.') - - if filters['end_date'] and not validate_date_format(filters['end_date']): - raise ValueError('Invalid end_date format. Use YYYY-MM-DD.') - - # Remove empty filters - filters = filter_empty_params(filters) - - result = reporting_service.search_transactions(filters) - return jsonify(result) - - elif action == 'detail': - # Get transaction details - validate_required_params(params, ['transaction_id']) - - result = reporting_service.get_transaction_details(params['transaction_id']) - return jsonify(result) - - elif action == 'settlement': - # Get settlement report - settlement_params = { - 'page': int(params.get('page', 1)), - 'page_size': min(int(params.get('page_size', 50)), 100), - 'start_date': params.get('start_date', ''), - 'end_date': params.get('end_date', '') - } - - # Validate date formats if provided - if settlement_params['start_date'] and not validate_date_format(settlement_params['start_date']): - raise ValueError('Invalid start_date format. Use YYYY-MM-DD.') - - if settlement_params['end_date'] and not validate_date_format(settlement_params['end_date']): - raise ValueError('Invalid end_date format. Use YYYY-MM-DD.') - - # Remove empty filters - settlement_params = filter_empty_params(settlement_params) - - result = reporting_service.get_settlement_report(settlement_params) - return jsonify(result) - - elif action == 'export': - # Export transaction data - export_filters = { - 'start_date': params.get('start_date', ''), - 'end_date': params.get('end_date', ''), - 'transaction_id': params.get('transaction_id', ''), - 'payment_type': params.get('payment_type', ''), - 'status': params.get('status', ''), - 'amount_min': params.get('amount_min', ''), - 'amount_max': params.get('amount_max', ''), - 'card_last_four': params.get('card_last_four', '') - } - - export_format = params.get('format', 'json') - if export_format not in ['json', 'csv', 'xml']: - raise ValueError('Invalid format. Supported formats: json, csv, xml') - - # Validate date formats if provided - if export_filters['start_date'] and not validate_date_format(export_filters['start_date']): - raise ValueError('Invalid start_date format. Use YYYY-MM-DD.') - - if export_filters['end_date'] and not validate_date_format(export_filters['end_date']): - raise ValueError('Invalid end_date format. Use YYYY-MM-DD.') - - # Remove empty filters - export_filters = filter_empty_params(export_filters) - - result = reporting_service.export_transactions(export_filters, export_format) - - if export_format == 'csv': - return Response( - result['data'], - mimetype='text/csv', - headers={'Content-Disposition': f'attachment; filename={result.get("filename", "transactions.csv")}'} - ) - elif export_format == 'xml': - return Response( - result['data'], - mimetype='application/xml', - headers={'Content-Disposition': f'attachment; filename={result.get("filename", "transactions.xml")}'} - ) - - return jsonify(result) - - elif action == 'summary': - # Get summary statistics - summary_params = { - 'start_date': params.get('start_date', ''), - 'end_date': params.get('end_date', '') - } - - # Validate date formats if provided - if summary_params['start_date'] and not validate_date_format(summary_params['start_date']): - raise ValueError('Invalid start_date format. Use YYYY-MM-DD.') - - if summary_params['end_date'] and not validate_date_format(summary_params['end_date']): - raise ValueError('Invalid end_date format. Use YYYY-MM-DD.') - - # Remove empty filters - summary_params = filter_empty_params(summary_params) - - result = reporting_service.get_summary_stats(summary_params) - return jsonify(result) - - elif action == 'disputes': - # Get dispute report - dispute_filters = { - 'page': int(params.get('page', 1)), - 'page_size': min(int(params.get('page_size', 10)), 100), - 'start_date': params.get('start_date', ''), - 'end_date': params.get('end_date', ''), - 'stage': params.get('stage', ''), - 'status': params.get('status', '') - } - - # Validate date formats if provided - if dispute_filters['start_date'] and not validate_date_format(dispute_filters['start_date']): - raise ValueError('Invalid start_date format. Use YYYY-MM-DD.') - - if dispute_filters['end_date'] and not validate_date_format(dispute_filters['end_date']): - raise ValueError('Invalid end_date format. Use YYYY-MM-DD.') - - # Remove empty filters - dispute_filters = filter_empty_params(dispute_filters) - - result = reporting_service.get_dispute_report(dispute_filters) - return jsonify(result) - - elif action == 'dispute_detail': - # Get dispute details - validate_required_params(params, ['dispute_id']) - - result = reporting_service.get_dispute_details(params['dispute_id']) - return jsonify(result) - - elif action == 'deposits': - # Get deposit report - deposit_filters = { - 'page': int(params.get('page', 1)), - 'page_size': min(int(params.get('page_size', 10)), 100), - 'start_date': params.get('start_date', ''), - 'end_date': params.get('end_date', ''), - 'deposit_id': params.get('deposit_id', ''), - 'status': params.get('status', '') - } - - # Validate date formats if provided - if deposit_filters['start_date'] and not validate_date_format(deposit_filters['start_date']): - raise ValueError('Invalid start_date format. Use YYYY-MM-DD.') - - if deposit_filters['end_date'] and not validate_date_format(deposit_filters['end_date']): - raise ValueError('Invalid end_date format. Use YYYY-MM-DD.') - - # Remove empty filters - deposit_filters = filter_empty_params(deposit_filters) - - result = reporting_service.get_deposit_report(deposit_filters) - return jsonify(result) - - elif action == 'deposit_detail': - # Get deposit details - validate_required_params(params, ['deposit_id']) - - result = reporting_service.get_deposit_details(params['deposit_id']) - return jsonify(result) - - elif action == 'batches': - # Get batch report - batch_filters = { - 'start_date': params.get('start_date', ''), - 'end_date': params.get('end_date', '') - } - - # Validate date formats if provided - if batch_filters['start_date'] and not validate_date_format(batch_filters['start_date']): - raise ValueError('Invalid start_date format. Use YYYY-MM-DD.') - - if batch_filters['end_date'] and not validate_date_format(batch_filters['end_date']): - raise ValueError('Invalid end_date format. Use YYYY-MM-DD.') - - # Remove empty filters - batch_filters = filter_empty_params(batch_filters) - - result = reporting_service.get_batch_report(batch_filters) - return jsonify(result) - - elif action == 'declines': - # Get declined transactions report - decline_filters = { - 'page': int(params.get('page', 1)), - 'page_size': min(int(params.get('page_size', 10)), 100), - 'start_date': params.get('start_date', ''), - 'end_date': params.get('end_date', ''), - 'payment_type': params.get('payment_type', ''), - 'amount_min': params.get('amount_min', ''), - 'amount_max': params.get('amount_max', ''), - 'card_last_four': params.get('card_last_four', '') - } - - # Validate date formats if provided - if decline_filters['start_date'] and not validate_date_format(decline_filters['start_date']): - raise ValueError('Invalid start_date format. Use YYYY-MM-DD.') - - if decline_filters['end_date'] and not validate_date_format(decline_filters['end_date']): - raise ValueError('Invalid end_date format. Use YYYY-MM-DD.') - - # Remove empty filters - decline_filters = filter_empty_params(decline_filters) - - result = reporting_service.get_declined_transactions_report(decline_filters) - return jsonify(result) - - elif action == 'date_range': - # Get comprehensive date range report - date_range_params = { - 'start_date': params.get('start_date', ''), - 'end_date': params.get('end_date', ''), - 'transaction_limit': min(int(params.get('transaction_limit', 100)), 1000), - 'settlement_limit': min(int(params.get('settlement_limit', 50)), 500), - 'dispute_limit': min(int(params.get('dispute_limit', 25)), 100), - 'deposit_limit': min(int(params.get('deposit_limit', 25)), 100) - } - - # Validate date formats if provided - if date_range_params['start_date'] and not validate_date_format(date_range_params['start_date']): - raise ValueError('Invalid start_date format. Use YYYY-MM-DD.') - - if date_range_params['end_date'] and not validate_date_format(date_range_params['end_date']): - raise ValueError('Invalid end_date format. Use YYYY-MM-DD.') - - # Remove empty filters - date_range_params = filter_empty_params(date_range_params) - - result = reporting_service.get_date_range_report(date_range_params) - return jsonify(result) - - elif action == 'config': - # Get configuration status - config_status = get_sdk_config_status() - env_validation = validate_environment_config() - - return jsonify({ - 'success': True, - 'data': { - 'sdk_status': config_status, - 'environment_validation': env_validation, - 'api_endpoints': { - 'search': '/reports?action=search', - 'detail': '/reports?action=detail&transaction_id={id}', - 'settlement': '/reports?action=settlement', - 'disputes': '/reports?action=disputes', - 'dispute_detail': '/reports?action=dispute_detail&dispute_id={id}', - 'deposits': '/reports?action=deposits', - 'deposit_detail': '/reports?action=deposit_detail&deposit_id={id}', - 'batches': '/reports?action=batches', - 'declines': '/reports?action=declines', - 'date_range': '/reports?action=date_range', - 'export': '/reports?action=export&format={json|csv|xml}', - 'summary': '/reports?action=summary', - 'config': '/reports?action=config' - } - }, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - }) - - elif action == '': - # Default action - show API documentation - return jsonify({ - 'success': True, - 'data': { - 'name': 'Global Payments Reporting API', - 'version': '1.0.0', - 'description': 'RESTful API for Global Payments transaction reporting and analytics', - 'endpoints': { - 'search': { - 'url': '/reports?action=search', - 'method': 'GET/POST', - 'description': 'Search transactions with filters and pagination', - 'parameters': { - 'page': 'Page number (default: 1)', - 'page_size': 'Results per page (default: 10, max: 100)', - 'start_date': 'Start date (YYYY-MM-DD)', - 'end_date': 'End date (YYYY-MM-DD)', - 'transaction_id': 'Specific transaction ID', - 'payment_type': 'Payment type (sale, refund, authorize, capture)', - 'status': 'Transaction status', - 'amount_min': 'Minimum amount', - 'amount_max': 'Maximum amount', - 'card_last_four': 'Last 4 digits of card' - } - }, - 'detail': { - 'url': '/reports?action=detail&transaction_id={id}', - 'method': 'GET', - 'description': 'Get detailed transaction information', - 'parameters': { - 'transaction_id': 'Transaction ID (required)' - } - }, - 'settlement': { - 'url': '/reports?action=settlement', - 'method': 'GET/POST', - 'description': 'Get settlement report', - 'parameters': { - 'page': 'Page number (default: 1)', - 'page_size': 'Results per page (default: 50, max: 100)', - 'start_date': 'Start date (YYYY-MM-DD)', - 'end_date': 'End date (YYYY-MM-DD)' - } - }, - 'export': { - 'url': '/reports?action=export&format={json|csv|xml}', - 'method': 'GET/POST', - 'description': 'Export transaction data', - 'parameters': { - 'format': 'Export format (json, csv, or xml)', - '...filters': 'Same filters as search endpoint' - } - }, - 'summary': { - 'url': '/reports?action=summary', - 'method': 'GET/POST', - 'description': 'Get summary statistics', - 'parameters': { - 'start_date': 'Start date (YYYY-MM-DD)', - 'end_date': 'End date (YYYY-MM-DD)' - } - }, - 'disputes': { - 'url': '/reports?action=disputes', - 'method': 'GET/POST', - 'description': 'Get dispute report', - 'parameters': { - 'page': 'Page number (default: 1)', - 'page_size': 'Results per page (default: 10, max: 100)', - 'start_date': 'Start date (YYYY-MM-DD)', - 'end_date': 'End date (YYYY-MM-DD)', - 'stage': 'Dispute stage', - 'status': 'Dispute status' - } - }, - 'deposits': { - 'url': '/reports?action=deposits', - 'method': 'GET/POST', - 'description': 'Get deposit report', - 'parameters': { - 'page': 'Page number (default: 1)', - 'page_size': 'Results per page (default: 10, max: 100)', - 'start_date': 'Start date (YYYY-MM-DD)', - 'end_date': 'End date (YYYY-MM-DD)', - 'deposit_id': 'Specific deposit ID', - 'status': 'Deposit status' - } - }, - 'batches': { - 'url': '/reports?action=batches', - 'method': 'GET/POST', - 'description': 'Get batch report', - 'parameters': { - 'start_date': 'Start date (YYYY-MM-DD)', - 'end_date': 'End date (YYYY-MM-DD)' - } - }, - 'declines': { - 'url': '/reports?action=declines', - 'method': 'GET/POST', - 'description': 'Get declined transactions report', - 'parameters': { - 'page': 'Page number (default: 1)', - 'page_size': 'Results per page (default: 10, max: 100)', - 'start_date': 'Start date (YYYY-MM-DD)', - 'end_date': 'End date (YYYY-MM-DD)', - 'payment_type': 'Payment type', - 'amount_min': 'Minimum amount', - 'amount_max': 'Maximum amount', - 'card_last_four': 'Last 4 digits of card' - } - }, - 'date_range': { - 'url': '/reports?action=date_range', - 'method': 'GET/POST', - 'description': 'Get comprehensive date range report', - 'parameters': { - 'start_date': 'Start date (YYYY-MM-DD)', - 'end_date': 'End date (YYYY-MM-DD)', - 'transaction_limit': 'Max transactions (default: 100, max: 1000)', - 'settlement_limit': 'Max settlements (default: 50, max: 500)', - 'dispute_limit': 'Max disputes (default: 25, max: 100)', - 'deposit_limit': 'Max deposits (default: 25, max: 100)' - } - }, - 'config': { - 'url': '/reports?action=config', - 'method': 'GET', - 'description': 'Get API configuration and status' - } - } - }, - 'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S') - }) - - else: - raise ValueError(f"Invalid action: {action}") - - except ValueError as e: - return handle_error(str(e), 400, 'VALIDATION_ERROR') - except ApiException as e: - return handle_error(str(e), 400, 'API_ERROR') - except Exception as e: - return handle_error(f'An unexpected error occurred: {str(e)}', 500, 'INTERNAL_ERROR') \ No newline at end of file diff --git a/python/requirements.txt b/python/requirements.txt deleted file mode 100644 index 4c4501d..0000000 --- a/python/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -Flask==3.0.0 -globalpayments.api==2.0.4 -gunicorn==21.2.0 -python-dotenv==1.0.0 diff --git a/python/run.sh b/python/run.sh deleted file mode 100755 index 79fcec9..0000000 --- a/python/run.sh +++ /dev/null @@ -1,19 +0,0 @@ -#!/bin/bash - -# Exit on error -set -e - -# Create virtual environment if it doesn't exist -if [ ! -d "venv" ]; then - python3 -m venv venv -fi - -# Activate virtual environment -source venv/bin/activate - -# Install requirements -pip install -r requirements.txt - -# Start the server -export FLASK_ENV=development -python server.py diff --git a/python/server.py b/python/server.py deleted file mode 100644 index a0ebe9c..0000000 --- a/python/server.py +++ /dev/null @@ -1,163 +0,0 @@ -""" -Global Payments SDK Template - Python Flask - -This Flask application provides a starting template for Global Payments SDK integration. -Includes comprehensive reporting functionality for transaction analytics and data export. -""" - -import os -import re -from flask import Flask, request, jsonify -from dotenv import load_dotenv -from globalpayments.api import PorticoConfig, ServicesContainer -from globalpayments.api.payment_methods import CreditCardData -from globalpayments.api.entities import Address -from globalpayments.api.entities.exceptions import ApiException - -# Import reporting routes -from reports import reports_bp - -# Load environment variables -load_dotenv() - -# Initialize application -app = Flask(__name__, static_folder='.') - -# Register reporting blueprint -app.register_blueprint(reports_bp) - -# Add CORS headers -@app.after_request -def add_cors_headers(response): - """Add CORS headers to all responses""" - response.headers['Access-Control-Allow-Origin'] = '*' - response.headers['Access-Control-Allow-Methods'] = 'GET, POST, OPTIONS' - response.headers['Access-Control-Allow-Headers'] = 'Content-Type, Authorization' - return response - -def configure_sdk(): - """ - Configure the Global Payments SDK with necessary credentials and settings. - Customize these settings for your environment. - """ - config = PorticoConfig() - config.secret_api_key = os.getenv('SECRET_API_KEY') - config.service_url = 'https://cert.api2.heartlandportico.com' # Use production URL for live transactions - config.developer_id = '000000' # Your developer ID - config.version_number = '0000' # Your version number - - ServicesContainer.configure(config) - -# Configure SDK on startup -configure_sdk() - -def sanitize_postal_code(postal_code: str) -> str: - """ - Utility function to sanitize postal code. - Customize validation logic as needed for your use case. - """ - sanitized = re.sub(r'[^a-zA-Z0-9-]', '', postal_code or '') - return sanitized[:10] - -@app.route('/') -def index(): - """Serve the main HTML page.""" - return app.send_static_file('index.html') - -@app.route('/config') -def get_config(): - """ - Config endpoint - provides public API key for client-side use. - Customize response data as needed. - """ - return jsonify({ - 'success': True, - 'data': { - 'publicApiKey': os.getenv('PUBLIC_API_KEY') - # Add other configuration data as needed - } - }) - -@app.route('/process-payment', methods=['POST']) -def process_payment(): - """ - Example payment processing endpoint. - Customize this endpoint for your specific payment flow. - """ - try: - # TODO: Add your payment processing logic here - # Example implementation for basic charge: - - if 'payment_token' not in request.form: - raise ApiException('Payment token is required') - - card = CreditCardData() - card.token = request.form['payment_token'] - - # Customize amount and other parameters as needed - amount = float(request.form.get('amount', 10.00)) - - # Add billing address if needed - if 'billing_zip' in request.form: - address = Address() - address.postal_code = sanitize_postal_code(request.form['billing_zip']) - - response = card.charge(amount)\ - .with_allow_duplicates(True)\ - .with_currency('USD')\ - .with_address(address)\ - .execute() - else: - # Process without address - response = card.charge(amount)\ - .with_allow_duplicates(True)\ - .with_currency('USD')\ - .execute() - - return jsonify({ - 'success': True, - 'message': 'Payment processed successfully', - 'data': {'transactionId': response.transaction_id} - }) - - except ApiException as e: - return jsonify({ - 'success': False, - 'message': 'Payment processing failed', - 'error': str(e) - }), 400 - except Exception as e: - return jsonify({ - 'success': False, - 'message': 'Payment processing failed', - 'error': str(e) - }), 500 - -# Add your custom endpoints here -# Examples: -# @app.route('/authorize', methods=['POST']) -# def authorize_payment(): -# # Authorization only logic -# pass -# -# @app.route('/capture', methods=['POST']) -# def capture_payment(): -# # Capture authorized payment logic -# pass -# -# @app.route('/refund', methods=['POST']) -# def refund_payment(): -# # Process refund logic -# pass -# -# @app.route('/transaction/') -# def get_transaction(transaction_id): -# # Get transaction details logic -# pass - -# Start the server if this file is run directly -if __name__ == '__main__': - port = int(os.getenv('PORT', 8000)) - print(f"Server running at http://localhost:{port}") - print("Customize this template for your use case!") - app.run(host='0.0.0.0', port=port, debug=True) \ No newline at end of file