API reference · Communities & institutions

Rentals bills

POST/rental/tenancy/{reference}/billPay a household bill for this tenancy
GET/rental/tenancy/{reference}/billsBills paid for this tenancy
GET/rental/unit/{reference}/costWhat a unit really costs a month

POST Pay a household bill for this tenancy

POST /rental/tenancy/{reference}/bill

Paid through the bills module from your main wallet and tagged to the tenancy, so the unit's real monthly cost can include it. Requires the transaction PIN.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: TenancyBillPaymentRequest · Response: GenericResponseTenancyBillPaymentResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/bill" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "productCode": "IKEDC-PREPAID",
  "customerIdentifier": "04123456789",
  "amount": 15000.0,
  "currencyCode": "NGN",
  "validationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "extraParameters": {},
  "idempotencyKey": "string"
}'

{
  "productCode": "IKEDC-PREPAID",
  "customerIdentifier": "04123456789",
  "amount": 15000.0,
  "currencyCode": "NGN",
  "validationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "extraParameters": {},
  "idempotencyKey": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "billPaymentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "productCode": "string",
    "categoryCode": "string",
    "amount": 0,
    "currencyCode": "string",
    "status": "string",
    "token": "string",
    "paidAt": "2026-09-25T10:00:00Z"
  },
  "description": "Bill paid successfully"
}

Responses

Status	When
`200`	Bill paid successfully

GET Bills paid for this tenancy

GET /rental/tenancy/{reference}/bills

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListTenancyBillPaymentResponse

curl -X GET "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/bills" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "billPaymentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "productCode": "string",
      "categoryCode": "string",
      "amount": 0,
      "currencyCode": "string",
      "status": "string",
      "token": "string",
      "paidAt": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Bills retrieved successfully"
}

Responses

Status	When
`200`	Bills retrieved successfully

GET What a unit really costs a month

GET /rental/unit/{reference}/cost

Rent per month, the estate's charges per month, and the bills actually paid for the unit, each with where it comes from. No figure names a person.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseUnitCostResponse

curl -X GET "https://api.bridgemoni.com/rental/unit/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/cost" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "currencyCode": "string",
    "trueMonthlyCost": 0,
    "lines": [
      {
        "kind": "RENT",
        "label": "string",
        "monthlyAmount": 0,
        "basis": "string",
        "observations": 0
      }
    ],
    "tenancyDurationMedianMonths": 0,
    "tenanciesObserved": 0
  },
  "description": "Unit cost retrieved successfully"
}

Responses

Status	When
`200`	Unit cost retrieved successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors