API reference · Communities & institutions

Rent savings

GET/rental/tenancy/{reference}/savingsRent savings position
POST/rental/tenancy/{reference}/savingsOpen or link the rent savings plan
POST/rental/tenancy/{reference}/savings/drawDraw the rent savings in one transaction
POST/rental/tenancy/{reference}/savings/reserveReserve the savings for rent now

GET Rent savings position

GET /rental/tenancy/{reference}/savings

Saved against target, the projected balance on the target date, and the options for closing a gap, shown before the due date rather than on it.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseRentSavingsResponse

curl -X GET "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/savings" \
  -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",
    "savingsPlanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "potAccountNumber": "string",
    "status": "ACTIVE",
    "currencyCode": "string",
    "targetAmount": 0,
    "targetDate": "2026-09-25",
    "savedAmount": 0,
    "reservedAmount": 0,
    "shortfall": 0,
    "projectedAtTargetDate": 0,
    "suggestedMonthlyContribution": 0,
    "monthlyContribution": 0,
    "lockOptIn": true,
    "options": [
      "string"
    ],
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Rent savings retrieved successfully"
}

Responses

Status	When
`200`	Rent savings retrieved successfully
`404`	The tenancy has no rent savings plan

POST Open or link the rent savings plan

POST /rental/tenancy/{reference}/savings

A target plan for the next rent this tenancy owes, funded monthly from your wallet if you ask. Not locked unless you opt in; at the due date the plan is reserved for rent by a lien instead. Your identity must be verified to the level the market needs for rent-scale sums, because a plan that cannot hold a year's rent is not a rent plan. Opening twice returns the plan you already have.

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: RentSavingsRequest · Response: GenericResponseRentSavingsResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/savings" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "monthlyContribution": 170000.0,
  "fundingDayOfMonth": 25,
  "sourceAccountNumber": "string",
  "lockUntilDue": true
}'

{
  "monthlyContribution": 170000.0,
  "fundingDayOfMonth": 25,
  "sourceAccountNumber": "string",
  "lockUntilDue": true
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "savingsPlanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "potAccountNumber": "string",
    "status": "ACTIVE",
    "currencyCode": "string",
    "targetAmount": 0,
    "targetDate": "2026-09-25",
    "savedAmount": 0,
    "reservedAmount": 0,
    "shortfall": 0,
    "projectedAtTargetDate": 0,
    "suggestedMonthlyContribution": 0,
    "monthlyContribution": 0,
    "lockOptIn": true,
    "options": [
      "string"
    ],
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Rent savings opened successfully"
}

Responses

Status	When
`200`	Rent savings opened successfully
`409`	Identity is not verified far enough for rent-scale sums in this market

POST Draw the rent savings in one transaction

POST /rental/tenancy/{reference}/savings/draw

Releases any rent reservation and withdraws through the savings plan's own withdrawal path to your main wallet, in one transaction. A draw that would cost a penalty is refused until the penalty is acknowledged.

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: RentSavingsDrawRequest · Response: GenericResponseRentSavingsDrawResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/savings/draw" \
  -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 '{
  "amount": 2000000.0,
  "acknowledgePenalty": true
}'

{
  "amount": 2000000.0,
  "acknowledgePenalty": true
}

{
  "data": {
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "savingsPlanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "withdrawalReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "currencyCode": "string",
    "grossAmount": 0,
    "penaltyAmount": 0,
    "netAmount": 0,
    "destinationAccountNumber": "string",
    "planSavedAmount": 0
  },
  "description": "Rent savings drawn successfully"
}

Responses

Status	When
`200`	Rent savings drawn successfully
`409`	The plan holds less, a penalty was not acknowledged, or identity is not verified far enough

POST Reserve the savings for rent now

POST /rental/tenancy/{reference}/savings/reserve

Places a lien on the plan for the rent still owed. The money stays yours and stays in the plan; it simply cannot be spent on anything else.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseRentSavingsResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/savings/reserve" \
  -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",
    "savingsPlanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "potAccountNumber": "string",
    "status": "ACTIVE",
    "currencyCode": "string",
    "targetAmount": 0,
    "targetDate": "2026-09-25",
    "savedAmount": 0,
    "reservedAmount": 0,
    "shortfall": 0,
    "projectedAtTargetDate": 0,
    "suggestedMonthlyContribution": 0,
    "monthlyContribution": 0,
    "lockOptIn": true,
    "options": [
      "string"
    ],
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Rent savings reserved successfully"
}

Responses

Status	When
`200`	Rent savings reserved successfully
`409`	Nothing is free to reserve, or it is already reserved

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