Gateways

What This Option Does

Gateways module configures payment providers used for subscription checkout.

How Admin Uses This

1. Open Gateways list and select a provider.
2. Enter/edit credentials and select test/live mode.
3. Activate gateway and save.
4. Run a test payment and confirm log status.

Screenshot Placeholder

Add screenshot file at documentaion/assets/images/backoffice-gateways.png

Enterprise Technical Specification

Business Capabilities

• Gateway list/view
• Gateway config update

API Contract Surface

Primary API endpoints used by this module:

• /api/v1/backoffice/gateways
• /api/v1/backoffice/gateways/{id}

Permission Blueprint

Recommended permission keys for production role design:

• backoffice.gateway.view
• backoffice.gateway.edit

Operational Risk and Control Notes

• Invalid credentials block payments
• Enable activity logging and include company_id, actor ID, and target entity ID in audit traces.
• Apply least-privilege principle for create/update/delete actions.

QA Verification Checklist

• Validate list API load, empty-state behavior, and pagination consistency.
• Verify create/update/delete response contract (status, message, data).
• Confirm permission denial responses for unauthorized roles.
• Test edge inputs and invalid IDs for safe error handling.