Backoffice Portal Documentation

Overview

Portal for managing charges, payments, transactions, and webhooks with role-based access control.

Environment URLs

Sandbox: https://bkof-portal-hml.astrapay.com.br
Production: https://bkof-portal.astrapay.com.br

Portal Benefits

The Backoffice Portal provides a comprehensive and user-friendly interface for managing all your payment operations:

Key Advantages:

🎯 Centralized Management: All payment operations in one place
⚡ Real-time Monitoring: Live updates on transactions and charges
🔐 Secure Access: Role-based permissions for different user types
📊 Advanced Reporting: Detailed analytics and export capabilities
🌐 Multi-language Support: Portuguese and English interfaces
📱 Responsive Design: Access from any device (mobile, tablet, desktop)
🔔 Automated Notifications: Webhook integration for real-time updates
💼 Multi-client Support: Manage multiple clients from a single interface

Main Dashboard

Route: /

Homepage with navigation cards for main modules. Displays only functionalities that the user has permission to access.

Available Modules:

Charges
Payment Links
Webhooks
Representatives
Transactions (Credit Card, Installments, Statement)

1. Charges

Route: /charges

Complete management of PIX charges.

Listing

Display:

Debtor name and CPF/CNPJ
Formatted amount
Status with badges
Tx ID

Filters:

Period (required)
Debtor CPF/CNPJ
User reference
Status
1-second debounce

Actions:

Create new charge
View details
Edit
Delete
Process refund (full or partial)

Create/Edit Charge

Fields:

Debtor name
CPF (required if "Validate Debtor" is active)
CNPJ (optional)
Amount (required, positive)
Description
User reference
Payer request
Expiration (max 60 minutes)
Additional information (dynamic fields)

Validations:

CPF/CNPJ with verification algorithm
Positive amount required
Conditionally required fields

2. Payment Links

Route: /payment-link

Creation and management of links to facilitate online charges.

Listing

Display:

Amount and installments
Payer name and CPF/CNPJ
Link URL
Status and payment method
Receipt
Creation date

Filters:

Period (required)
Payment receipt
User reference
CPF/CNPJ
Payment method (PIX, Boleto, Card)
Status

Actions:

Create link
View details and transactions
Cancel link
Copy URL
Download report

Create Link

Features:

Amount and installment configuration
Payer data
Accepted methods selection
Due date
Automatic URL and token generation

3. Webhooks

Route: /webhook

Webhook configuration to receive event notifications.

Listing

Display:

Webhook URL
Event type
Status (active/inactive)

Actions:

Create webhook
Edit
Delete
Filter by URL

Create/Edit Webhook

Fields:

Destination URL (HTTPS required)
Event type
Active/inactive status

4. Representatives

Route: /representatives

Management of client representative users.

Listing

Display:

First and last name
Email
Formatted CPF/CNPJ
International phone
Status

Filters:

CPF/CNPJ
Representative name
1-second debounce

Actions:

Create representative
Edit data
Change password
Delete
Activate/deactivate access

Create/Edit Representative

Fields:

First and last name
Unique email
Validated CPF/CNPJ
Phone with country code
Password (creation only)
Roles/Permissions

Validations:

Unique email
Valid CPF/CNPJ
Strong password (8+ characters, uppercase, lowercase, numbers, special)
Password confirmation

5. Transactions

5.1 Credit Card

Route: /transactions/credit-card

Credit card transaction visualization.

Display:

Cardholder name
Last 4 digits
Formatted amount
Status with custom badges
Date and identification
Installments and type (debit/credit)
Brand with icon

Filters:

Period (required)
Transaction identification
Status

Actions:

View complete details
Cancel/refund transaction
Export report

Available Status:

Approved (green)
Pending (yellow)
Denied (red)
Cancelled (gray)
Under review (blue)

5.2 Installments

Route: /transactions/installments

Installment details for transactions.

Display:

Cardholder and masked card
Installment number (X/Y)
Net and total amounts
Fee percentage
Dates (transaction and payment)

Filters:

Transaction date
Future payment date
NSU
Payment type

Actions:

View installment details
See original transaction

5.3 Statement

Route: /transactions/statement

Complete transaction statement.

Display:

Terminal (ID, serial, name)
Brand and purchase type
Installments
Dates (transaction and payment)
Codes (authorization, NSU)
Amounts
Status (transaction and payment)
Masked card

Filters:

Period (required)
Status

Export:

Formatted PDF
Excel (XLSX)
Filename with applied filters

6. Customer Selector

Route: /customer-selector

Modal for context switching when representative has multiple clients.

Features:

Available clients list
Search
Selection with persistence
Required modal until selection

7. User Profile

Route: /me

Settings and information for the logged-in user.

About Me

Information:

Full name
Email
CPF/CNPJ
Phone
Roles/Permissions
Creation date
Last access

Features:

Edit personal data
Real-time validations

Change Password

Fields:

Current password (verification)
New password
Confirm new password

Requirements:

8+ characters
Uppercase and lowercase
Numbers
Special characters

Permission System

Available Roles:

CHARGES - Charges
WEBHOOK - Webhooks
PAYMENT_LINK - Payment links
REPRESENTATIVES - Representatives
CREDIT_CARD - Credit card transactions
STATEMENT - Statement

Granular control with verification in routes and components.