Documentation language

BramaPay Dashboard API Reference

Start here

BramaPay documentation Getting started with BramaPay How payments work Integration readiness Quick start Test and Live Your first Test payment

Dashboard guides

Projects Merchant wallets Choosing a Payment Wallet API Keys

Integration v2

Multi-route payment sessions (v2)Open hosted checkout Confirm an order Return URLs Success & Cancel Redirects Redirect Security Best Practices

Webhooks

Overview Configure Webhooks Signature verification Webhook Security Events & Payloads Delivery retries Deduplicate events and orders Testing Webhooks

API Reference v2

API Reference v2 Authentication API Key Security Payment Sessions v2 Checkout capability boundary Errors and safe retries Assets API

Payment handling

Refunds and returns of funds Session deadlines and final confirmation Exact payment instructions Payment Mismatches Assets accepted by your wallet Networks and assets TRON: Mainnet and Shasta Network identifiers Asset identifiers

Billing and rewards

Fees and service balance Non-Custodial Model Buyer-paid payment fee Ledger & Treasury Top-ups Balance reminders Referral rewards Referral Withdrawals

Troubleshooting

FAQ Error Codes

Legacy v1

Invoices API Creating Invoices Invoice Lifecycle Invoice Statuses

Management API · JWT

Projects API Wallets API Billing & Treasury API Webhooks API Referrals API Integration contract notes

API Reference v2

Server-side hosted payment sessions.

Use a project secret key in X-Api-Key only from your server. The key fixes project and Test/Live scope. Management endpoints use JWT Bearer authentication; checkout uses a separate capability. API v2 is independent of webhook protocol v2.

Start with the session contract, checkout boundary, errors and signature verifier. Existing v1 invoices remain documented for legacy integrations.

Testing Webhooks

Validate endpoint connectivity without simulating money.

Authentication

Choose the correct server API or Dashboard session boundary.