Docs

Integration readiness

Complete setup before issuing a Live API key or creating payments.

Configure the project in this order:

  1. Select the project and mode.
  2. Register an active receiving wallet, explicitly accepting the required asset on the correct network. Where several eligible wallets exist, choose the intended default.
  3. Set successUrl, cancelUrl and exact allowedRedirectDomains.
  4. Add an active webhook endpoint and save its one-time secret and key ID.
  5. Implement signature verification and successfully deliver the connection test to every active Live endpoint.
  6. Create the project secret API key and store it on your server.

Live key issuance checks account status, hosted checkout configuration, wallet, return URLs, webhook and the successful test for the current configuration. It does not require an existing key. Changing a wallet, return URL, endpoint URL or secret can require a fresh successful test before another Live key can be issued. A Test connection test does not certify Live.

New Live payments require B + C > 0, where B is the actual service balance and C is approved credit. C defaults to $0; only the BramaPay chief administrator (staff role OWNER) can approve a limit of $0–$10; merchants cannot approve their own credit. At B + C <= 0, new creation stops. B alone may be zero or negative when C permits creation. Issued payments keep processing and can increase debt beyond the threshold. Unpaid commission is not reserved. Check the effective fee and available routes. See quick start.