API reference · Communities & institutions

Rent payments

POST/rental/tenancy/{reference}/payPay rent
POST/rental/tenancy/{reference}/payment-accountA bank account number for this tenancy's rent
GET/rental/tenancy/{reference}/paymentsRent paid through the platform, with allocations and obligations

POST Pay rent

POST /rental/tenancy/{reference}/pay

Rent is received on the landlord's behalf into the market's client money account and paid out to them on the settlement cycle. The occupant sees one price; the platform fee and the tax on it come out of the landlord's side. A repeat with the same Idempotency-Key returns the original payment. Requires the transaction PIN.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Idempotency-Key`	Reuse the same value on every retry of this request
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: RentPaymentRequest · Response: GenericResponseRentPaymentResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/pay" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "chargeReferences": [
    "string"
  ],
  "amount": 2000000.0,
  "currencyCode": "NGN",
  "source": {
    "kind": "WALLET",
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  }
}'

{
  "chargeReferences": [
    "string"
  ],
  "amount": 2000000.0,
  "currencyCode": "NGN",
  "source": {
    "kind": "WALLET",
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  }
}

{
  "data": {
    "paymentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "financialTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "RECEIVED",
    "rail": "WALLET",
    "amount": 0,
    "currencyCode": "string",
    "valueDate": "2026-09-25",
    "assuranceGrade": "G0_ASSERTED",
    "allocations": [
      {
        "chargeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "chargeType": "RENT",
        "periodStart": "2026-09-25",
        "periodEnd": "2026-09-25",
        "amountApplied": 0,
        "chargeStatus": "BEFORE_REGISTRATION"
      }
    ],
    "charges": [
      {
        "category": "string",
        "narrative": "string",
        "amount": 0,
        "borneBy": "OCCUPANT"
      }
    ],
    "obligations": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "payeeRole": "LANDLORD",
        "obligationType": "RENT",
        "grossAmount": 0,
        "netAmount": 0,
        "status": "PENDING",
        "releaseAt": "2026-09-25T10:00:00Z",
        "holdReason": "string"
      }
    ],
    "receipt": {
      "receiptNumber": "string",
      "issuedAt": "2026-09-25T10:00:00Z"
    }
  },
  "description": "Rent paid successfully"
}

Responses

Status	When
`200`	Rent paid successfully
`400`	The amount does not match what the charges owe
`403`	The transaction PIN was not validated
`409`	Rent cannot move on this tenancy yet, or identity is not verified far enough

POST A bank account number for this tenancy's rent

POST /rental/tenancy/{reference}/payment-account

Money paid into it from any bank is recognised as rent for this tenancy exactly, by the account it arrived in. On a tenancy that cannot take rent yet, it stays in your wallet and is reported as unattributable; it never goes to a landlord nobody verified.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseTenancyPaymentAccountResponse

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

{
  "data": {
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "accountNumber": "string",
    "accountName": "ADA OKAFOR",
    "institutionCode": "string",
    "currencyCode": "string",
    "status": "string"
  },
  "description": "Payment account issued successfully"
}

Responses

Status	When
`200`	Payment account issued successfully
`409`	No bank issued an account number

GET Rent paid through the platform, with allocations and obligations

GET /rental/tenancy/{reference}/payments

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListRentPaymentResponse

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

{
  "data": [
    {
      "paymentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "financialTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "status": "RECEIVED",
      "rail": "WALLET",
      "amount": 0,
      "currencyCode": "string",
      "valueDate": "2026-09-25",
      "assuranceGrade": "G0_ASSERTED",
      "allocations": [
        {
          "chargeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "chargeType": "RENT",
          "periodStart": "2026-09-25",
          "periodEnd": "2026-09-25",
          "amountApplied": 0,
          "chargeStatus": "BEFORE_REGISTRATION"
        }
      ],
      "charges": [
        {
          "category": "string",
          "narrative": "string",
          "amount": 0,
          "borneBy": "OCCUPANT"
        }
      ],
      "obligations": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "payeeRole": "LANDLORD",
          "obligationType": "RENT",
          "grossAmount": 0,
          "netAmount": 0,
          "status": "PENDING",
          "releaseAt": "2026-09-25T10:00:00Z",
          "holdReason": "string"
        }
      ],
      "receipt": {
        "receiptNumber": "string",
        "issuedAt": "2026-09-25T10:00:00Z"
      }
    }
  ],
  "description": "Payments retrieved successfully"
}

Responses

Status	When
`200`	Payments retrieved successfully

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