Payvala

Assistant

Payvala Assistant

Suggestions

Press Enter to send · Shift+Enter for new line

Architecture Overview

The Payvala platform is organized into distinct layers that work together to handle external integrations, security, business operations and downstream communication.

External requests enter through Cloudflare and the API Gateway, followed by mutual TLS (mTLS), before reaching the Payvala API. The Payvala API applies authentication, authorization and request validation before forwarding requests to the required business service.

The Core Business Services layer provides capabilities such as Transaction, Merchant, Institution and Configuration Services. Based on the operation, Payvala can communicate with downstream components through API responses, Webhooks or MQTT-based Physical and Virtual Soundbox delivery.

Staging and Production environments are maintained separately with their own endpoints, certificates, credentials, keys and network configurations.

High-Level Architecture

The Payvala platform follows a layered architecture that defines how Financial Institutions communicate with Payvala and how requests are securely processed across the platform.

External communication follows a common path: Partner or FI → Cloudflare → API Gateway → mTLS → Payvala API. This provides the controlled entry boundary for all supported Payvala integrations.

After reaching the Payvala API, every request passes through authentication, authorization and request validation before it can access the platform's internal services. This ensures that only authenticated, authorized and valid requests are processed.

The platform then routes the request to the required business capability, such as Transaction, Merchant, Institution or Configuration Services. These services operate behind the common API and security layers, so individual services do not require separate external integration paths.

Depending on the requested operation, Payvala can communicate with downstream components through appropriate mechanisms such as API responses, Webhooks or MQTT-based Physical and Virtual Soundbox delivery.

This architecture creates a clear separation between external systems, security controls, business services and downstream components, while Staging and Production remain independently configured environments.

Loading diagram...

Platform Layers

The Payvala architecture is organized into logical layers so that integration responsibilities, security boundaries and operational ownership remain clear.

FI Systems & Integration

FI CBS, outbound integration gateway, egress IP/CIDR, payerRef mapping, NTP, monitoring, retry/backoff, signing functions and protected private key material.

POEMS Administration

Organization onboarding, legal/entity information, organizational hierarchy, RBAC, user access, device administration, authentication configuration, limits and alerts.

Network & Transport Security

Registered FI egress IP/CIDR allowlisting, TLS 1.3, mutual TLS, Payvala Certificate Authority and environment-specific certificate controls.

Authorization & Request Security

OAuth 2.0 FAPI 2.0 Advanced, mandatory PAR, JAR, JWS/JWE, JWKS, HMAC-SHA256, timestamp and nonce validation.

Validation & Transaction Processing

Request decryption and signature verification, payload integrity validation, replay protection, rate controls, txnId idempotency and Transaction Notification API processing.

Messaging & Soundbox Delivery

Encrypted notification publication through MQTT to Physical Soundbox and Android-based Virtual Soundbox consumers.

Audit & Operations

requestId and txnId tracing, security audit records, API monitoring, credential and certificate monitoring, delivery tracking and operational alerts.

Security

Defense in depth, zero-trust principles, least privilege, IP Whitelisting, mTLS, OAuth/FAPI, JAR, JWS/JWE, HMAC, replay protection and controlled credential rotation.

API & Integration Layer

The Payvala API layer provides the REST-based interface through which Financial Institutions integrate with the Payvala platform.

The FI-facing APIs are available in separate Staging and Production environments. Each environment uses its own configuration and credentials, and the environments are not interchangeable.

The API layer supports authentication and authorization, partner and credential management, transaction notification and security-related key exchange required for FI integration.

Authentication & Authorization APIs

Provide the APIs required for Financial Institution authentication and authorization, including the issuance of scoped OAuth access tokens.

Partner Management APIs

Support the lifecycle of integration credentials and authorization codes, including generation, retrieval and status management.

Transaction Notification API

Receives real-time payment events from the Financial Institution for processing and subsequent merchant Soundbox notification delivery.

Security Infrastructure APIs

Provide the API-level infrastructure required for public-key exchange and the configured payload signing and encryption model.

FI Soundbox Onboarding APIs

Support FI-side merchant and Soundbox onboarding, including merchant registration, device binding, merchant-device mapping and device status operations, where applicable.

Endpoint URLs, methods, headers, request and response schemas, examples and API-specific error codes are documented in Developer > API.

Event & Messaging Architecture

The Event & Messaging Architecture defines how events and messages move between Payvala services and supported downstream consumers.

Business services generate or process events based on the required operation. The platform then applies the required processing and routing before forwarding the message to the configured delivery mechanism.

For Soundbox delivery, the documented architecture uses an MQTT Broker as the messaging boundary between Payvala processing services and Soundbox consumers.

Event Source

Core Payvala services generate or receive events as part of supported business operations.

Message Processing

Payvala processes the event and prepares the message for the required downstream delivery.

Message Routing

The processed message is routed to the appropriate configured delivery mechanism or consumer.

MQTT Broker

For Soundbox delivery, the MQTT Broker provides the messaging boundary through which messages are published to configured Soundbox consumers.

Message Consumer

Configured downstream consumers receive the message and perform the required delivery or presentation.

Notification & Device Layer

Physical and Virtual Soundbox devices are downstream consumers of the Payvala transaction notification flow.

Physical Soundbox devices use supported IoT mobile connectivity. The specification states that the device supports 2G and 4G data and that the FI must coordinate the required IoT SIM provisioning and testing with the selected mobile operator.

The Virtual Soundbox is an Android-based application and does not require an IoT SIM. Both device types provide the merchant with payment confirmation after MQTT delivery.

MQTT Delivery

Delivers the protected transaction notification from Payvala to the configured Soundbox consumer.

Physical Soundbox

Device-based payment notification consumer using supported 2G/4G IoT connectivity.

Virtual Soundbox

Android-based payment notification consumer that does not require an IoT SIM.

Merchant Confirmation

Final operational outcome where the merchant receives the payment confirmation through the configured Soundbox channel.

Request & Transaction Flow

FI onboarding starts with organization registration and access configuration in POEMS, followed by FI-side network, mTLS, OAuth, signing/encryption, time synchronization, retry, logging and monitoring configuration.

During a transaction, the FI CBS generates the payment event and the FI integration gateway prepares the secured Payvala request. Payvala validates the request, checks transaction idempotency and processes only accepted notifications for downstream delivery.

A repeated txnId is handled as an idempotent retry and must not cause a second Soundbox broadcast.

1

FI Onboarding

Register the Financial Institution in POEMS and configure organization hierarchy, users, RBAC and administrative access.

2

Security Configuration

Configure IP allowlisting, TLS/mTLS, OAuth/FAPI, JWKS, signing/encryption, keys, limits, alerts and rotation policies.

3

CBS Transaction Event

The FI CBS generates the real-time credit receipt or payment notification event.

4

Secure API Request

The FI integration gateway prepares the protected request using the configured authentication and request-integrity controls.

5

Network & mTLS Validation

Payvala applies registered egress IP controls and validates the FI client certificate over the secured transport.

6

Authorization & Request Validation

Payvala validates OAuth/FAPI authorization and the configured JAR, JWS/JWE, HMAC, timestamp and nonce controls.

7

Idempotency Check

Payvala validates txnId uniqueness and treats repeated submissions as idempotent retries.

8

Transaction Notification

The accepted payment event is processed by the Transaction Notification API.

9

MQTT Delivery

The protected notification is published to MQTT for downstream Soundbox delivery.

10

Merchant Confirmation

The Physical or Virtual Soundbox receives the notification and provides payment confirmation to the merchant.

Loading diagram...

Security Architecture

Payvala applies defense in depth so that an FI request must pass network, transport, authorization, request-integrity, replay and idempotency controls before transaction processing.

The documented security model follows strong mutual authentication, least privilege, end-to-end non-repudiation, defense in depth and a zero-trust network approach.

Production FI egress IPs are pre-registered and whitelisted. Each FI uses a Payvala-issued client certificate for mutual TLS. OAuth 2.0 follows the documented FAPI 2.0 Advanced profile with mandatory PAR and short-lived sender-constrained mTLS-bound access tokens.

Request security uses JAR for signed request objects and the configured JWS/JWE and HMAC-SHA256 controls. Timestamp and nonce validation provide replay protection, while txnId provides transaction-level idempotency.

Network Security

Registered FI egress IP/CIDR allowlisting and platform-edge network filtering.

TLS 1.3 & mTLS

TLS 1.3 minimum for API traffic with FI-specific mutual TLS client certificates and certificate validation.

OAuth 2.0 / FAPI

FAPI 2.0 Advanced authorization with mandatory PAR and short-lived sender-constrained mTLS-bound access tokens.

JAR / JWS / JWE

Signed request objects and configured cryptographic controls provide request authenticity, integrity and confidentiality.

HMAC-SHA256

AccessKey-based HMAC protects request integrity and detects payload manipulation.

Replay Protection

Timestamp and unique nonce validation using NTP-synchronised systems.

Idempotency

txnId-based duplicate detection prevents repeated transaction notifications from being rebroadcast.

RBAC & Audit

Least-privilege administration, role restrictions, approvals and auditable sensitive actions.

Data & Privacy Architecture

The architecture separates FI-owned payer identity information from the transaction reference exchanged with Payvala.

payerRef is an opaque, bank-generated reference token that replaces direct payer Personally Identifiable Information (PII). The FI owns and protects the mapping between payerRef and the underlying payer identity.

Payvala treats payerRef as an opaque identifier and does not perform reverse lookup, enrichment or identity interpretation. Sensitive private keys and shared secrets must remain protected in HSM or hardware-backed secret management and must not be hardcoded, exposed in URLs or written to logs.

Organization & Hierarchy Data

Legal entity, organizational hierarchy, branches/units and administrative configuration.

User & RBAC Data

FI administrators, users, roles, permissions, approvals and audit context.

Merchant & Device Data

Merchant/device association, device identifiers, allocation and device lifecycle information.

Transaction Data

Payment notification data, txnId, requestId, processing outcomes and delivery-related information.

Credential & Security Data

Access identifiers, authorization codes, certificates, JWKS configuration, rotation status, limits and security policies.

Audit & Operational Data

Authentication, validation, key usage, RBAC, security, monitoring and incident-investigation records.

The supplied FI integration specification defines logical data responsibilities but does not prescribe a physical database engine or internal persistence topology.

Service Communication

Payvala uses synchronous REST API communication for authentication, partner-management operations and FI transaction notification requests that require an API response.

After transaction acceptance, Soundbox notification delivery becomes asynchronous through MQTT. This separates transaction processing from downstream device consumption.

Communication boundaries are protected by the applicable IP, transport, authorization, cryptographic integrity, replay and idempotency controls.

Observability & Operations

requestId and txnId provide end-to-end correlation for request processing, transaction handling and delivery tracking.

Operational monitoring covers API failures, throttling, security events, credential and certificate status, request tracing, delivery status and transaction anomalies.

Security-relevant activity is audited, including authentication attempts, token issuance, request validation, key usage and rotation, RBAC actions and security events. The specification requires minimum log retention of 12 months.

Reliability & Failure Handling

The FI integration must use controlled retry and exponential backoff for recoverable API failures rather than uncontrolled repeated traffic.

Payvala applies TPS, burst and time-window limits. Consecutive HMAC validation failures can activate the documented security circuit breaker, after which further requests are rejected until manual operational investigation and clearance.

Duplicate txnId submissions are handled idempotently. A duplicate request can return HTTP 200 with an idempotent outcome without causing a second Soundbox broadcast.

Timeout Handling

Controls API calls that do not complete within the expected processing period.

Retry & Backoff

Uses controlled retry and backoff for recoverable FI-to-Payvala communication failures.

Rate & Burst Limits

Applies configured TPS, burst and hourly/daily limits to protect the integration.

HMAC Circuit Breaker

Three consecutive HMAC validation failures can activate the documented security circuit breaker and require manual recovery.

Idempotent Retry

Duplicate txnId submissions are treated as idempotent retries without rebroadcasting the notification.

Audit & Recovery

Failure, recovery and operational activity remain traceable through audit and monitoring records.

Endpoint-specific status codes and retry limits belong in Developer > API.

Environment Architecture

The integration specification defines separate Staging and Production environments. They are fully isolated and use environment-specific endpoints, certificates, keys, tokens, credentials and configuration.

Staging credentials must not be used against Production endpoints, and Production credentials must not be used against Staging endpoints. IP allowlisting is configured separately for each environment.

The same security model applies to both environments, while Production adds live operational controls, production allowlisting, production credential lifecycle and go-live governance.

Staging

Isolated environment for integration testing, security validation, transaction testing and onboarding readiness.

Production

Isolated live environment using production certificates, credentials, allowlists, limits, monitoring and operational runbooks.

Architecture Responsibilities & Boundaries

The architecture separates responsibilities between the Financial Institution and Payvala so that ownership of integration components, sensitive information, security controls and notification delivery remains clear.

The FI owns its CBS, outbound integration gateway, payer identity mapping, protected private credentials, NTP synchronization, monitoring, retry/backoff and FI-side logging. Payvala owns POEMS provisioning, platform-side security enforcement, certificate lifecycle, authorization services, request validation, transaction processing, MQTT delivery and platform operational monitoring.

The payerRef mapping remains within the FI environment. Payvala receives only the opaque payerRef and does not perform reverse identity lookup or enrichment.

Secure. Reliable. Scalable.

Payvala is built with enterprise-grade security, 99.9% uptime, and scalable infrastructure.