BramaPay Docs

Events & Payloads

Current event types, identities, and fulfillment fields.

Event identity

X-Event-Id is the stable logical event ID and is also copied to X-Idempotency-Key. X-Delivery-Id identifies the endpoint-specific delivery. Retries and manual redelivery keep the logical event identity.

invoice.paid

This is the only current invoice-fulfillment event. Its JSON body contains the canonical settlement fields:

{
  "invoiceId": "7b9e8f31-3b0e-46ae-96f0-d3c47540db4b",
  "externalId": "ORDER-58391",
  "userId": "MERCHANT_USER_ID",
  "status": "PAID",
  "amountPaid": "149.990001",
  "amountExpected": "149.990001",
  "txHash": "BLOCKCHAIN_TRANSACTION_HASH",
  "chain": "TRON"
}

After signature verification, require status === "PAID", match the stored invoiceId and externalId, and fulfill idempotently.

treasury.credited

Signals that an account-level treasury deposit credited the BramaPay service balance. It is not a customer payment and must not fulfill an order.

integration.test

Validates endpoint connectivity and signature handling. It never represents a payment. Route logic by the signed X-Event-Type; reject any conflict between expected event handling and body data.

On this page